README: add instructions for development build

The readme currently only details how to install the CLI from a binary
package, not how to build the CLI for testing during development. Add
instructions for how to build and test changes.

Change-type: patch
Signed-off-by: Joseph Kogut <joseph@balena.io>

.gitattributes

@@ -4,13 +4,9 @@
 *.* -eol
 
 *.sh text eol=lf
-.dockerignore eol=lf
-Dockerfile eol=lf
-Dockerfile.* eol=lf
-* text=auto eol=lf
 
 # lf for the docs as it's auto-generated and will otherwise trigger an uncommited error on windows
-docs/balena-cli.md text eol=lf
+doc/cli.markdown text eol=lf
 # crlf for the eol conversion test files
 tests/test-data/projects/docker-compose/basic/service2/file2-crlf.sh eol=crlf
 tests/test-data/projects/no-docker-compose/basic/src/windows-crlf.sh eol=crlf

.github/ISSUE_TEMPLATE.md

@@ -67,7 +67,7 @@ fixed it.
 - **Cloud backend: openBalena or balenaCloud?** If unsure, it will be balenaCloud
 - **Operating system version:** e.g. Windows 10, Ubuntu 18.04, macOS 10.14.5
 - **32/64 bit OS and processor:** e.g. 32-bit Windows on 64-bit Intel processor
-- **Install method:** npm or standalone package or executable installer
+- **Install method:** npm or zip package or executable installer
 - **If npm install, Node.js and npm version:** e.g. Node v8.16.0 and npm v6.4.1
 
 # Additional References

.github/actions/publish/action.yml

@@ -1,145 +0,0 @@
----
-name: package and draft GitHub release
-# https://github.com/product-os/flowzone/tree/master/.github/actions
-inputs:
-  json:
-    description: 'JSON stringified object containing all the inputs from the calling workflow'
-    required: true
-  secrets:
-    description: 'JSON stringified object containing all the secrets from the calling workflow'
-    required: true
-  variables:
-    description: 'JSON stringified object containing all the variables from the calling workflow'
-    required: true
-
-  # --- custom environment
-  XCODE_APP_LOADER_EMAIL:
-    type: string
-    default: 'accounts+apple@balena.io'
-  NODE_VERSION:
-    type: string
-    default: '22.x'
-  VERBOSE:
-    type: string
-    default: 'true'
-
-runs:
-  # https://docs.github.com/en/actions/creating-actions/creating-a-composite-action
-  using: 'composite'
-  steps:
-    - name: Download custom source artifact
-      uses: actions/download-artifact@cc203385981b70ca67e1cc392babf9cc229d5806 # v4.1.9
-      with:
-        name: custom-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ runner.os }}-${{ runner.arch }}
-        path: ${{ runner.temp }}
-
-    - name: Extract custom source artifact
-      shell: pwsh
-      working-directory: .
-      run: tar -xf ${{ runner.temp }}/custom.tgz
-
-    - name: Setup Node.js
-      uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
-      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
-      run: |
-        choco install yq
-
-    - name: Install additional tools
-      if: runner.os == 'macOS'
-      shell: bash
-      run: |
-        brew install coreutils
-
-    # https://www.electron.build/code-signing.html
-    # https://github.com/Apple-Actions/import-codesign-certs
-    - name: Import Apple code signing certificate
-      if: runner.os == 'macOS'
-      uses: apple-actions/import-codesign-certs@8f3fb608891dd2244cdab3d69cd68c0d37a7fe93 # v2
-      with:
-        p12-file-base64: ${{ fromJSON(inputs.secrets).APPLE_SIGNING }}
-        p12-password: ${{ fromJSON(inputs.secrets).APPLE_SIGNING_PASSWORD }}
-
-    - name: Import Windows code signing certificate
-      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
-        Remove-Item -path ${{ runner.temp }} -include certificate.base64
-      env:
-        SM_CLIENT_CERT_FILE_B64: ${{ fromJSON(inputs.secrets).SM_CLIENT_CERT_FILE_B64 }}
-
-    # https://github.com/product-os/scripts/tree/master/shared
-    # https://github.com/product-os/balena-concourse/blob/master/pipelines/github-events/template.yml
-    - name: Package release
-      shell: bash
-      run: |
-        set -ea
-
-        [[ '${{ inputs.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
-
-        runner_os="$(echo "${RUNNER_OS}" | tr '[:upper:]' '[:lower:]')"
-        runner_arch="$(echo "${RUNNER_ARCH}" | tr '[:upper:]' '[:lower:]')"
-
-        if [[ $runner_os =~ darwin|macos|osx ]]; then
-            CSC_KEY_PASSWORD='${{ fromJSON(inputs.secrets).APPLE_SIGNING_PASSWORD }}'
-            CSC_KEYCHAIN=signing_temp
-            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 }}
-
-            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
-            smctl.exe windows certsync
-            /c/Windows/System32/certutil.exe -csp "DigiCert Signing Manager KSP" -key -user
-
-            # (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}"
-        fi
-
-        npm run package
-
-        find dist -type f -maxdepth 1
-
-      env:
-        # 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
-        # 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@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
-      with:
-        name: gh-release-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ strategy.job-index }}
-        path: |
-          dist
-          !dist/balena
-        retention-days: 1
-        if-no-files-found: error

.github/actions/test/action.yml

@@ -1,65 +0,0 @@
----
-name: test release
-# https://github.com/product-os/flowzone/tree/master/.github/actions
-inputs:
-  json:
-    description: "JSON stringified object containing all the inputs from the calling workflow"
-    required: true
-  secrets:
-    description: "JSON stringified object containing all the secrets from the calling workflow"
-    required: true
-  variables:
-    description: "JSON stringified object containing all the variables from the calling workflow"
-    required: true
-
-  # --- custom environment
-  NODE_VERSION:
-    type: string
-    default: '22.x'
-  VERBOSE:
-    type: string
-    default: "true"
-
-runs:
-  # https://docs.github.com/en/actions/creating-actions/creating-a-composite-action
-  using: "composite"
-  steps:
-    # https://github.com/actions/setup-node#caching-global-packages-data
-    - name: Setup Node.js
-      uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
-      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: Test release
-      shell: bash
-      run: |
-        set -ea
-
-        [[ '${{ inputs.VERBOSE }}' =~ on|On|Yes|yes|true|True ]] && set -x
-
-        if [[ -e package-lock.json ]] || [[ -e npm-shrinkwrap.json ]]; then
-            npm ci
-        else
-            npm i
-        fi
-
-        npm run build
-        npm run test:core
-
-    - name: Compress custom source
-      shell: pwsh
-      run: tar --exclude-vcs -acf ${{ runner.temp }}/custom.tgz .
-
-    - name: Upload custom artifact
-      uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
-      with:
-        name: custom-${{ github.event.pull_request.head.sha || github.event.head_commit.id }}-${{ runner.os }}-${{ runner.arch }}
-        path: ${{ runner.temp }}/custom.tgz
-        retention-days: 1

.github/renovate.json

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

.github/workflows/flowzone.yml

@@ -1,45 +0,0 @@
-name: Flowzone
-on:
-  pull_request:
-    types: [opened, synchronize, closed]
-    branches: [main, master]
-  pull_request_target:
-    types: [opened, synchronize, closed]
-    branches: [main, master]
-jobs:
-  flowzone:
-    name: Flowzone
-    uses: product-os/flowzone/.github/workflows/flowzone.yml@master
-    # prevent duplicate workflow executions for pull_request and pull_request_target
-    if: |
-      (
-        github.event.pull_request.head.repo.full_name == github.repository &&
-        github.event_name == 'pull_request'
-      ) || (
-        github.event.pull_request.head.repo.full_name != github.repository &&
-        github.event_name == 'pull_request_target'
-      )
-    secrets: inherit
-    with:
-      custom_test_matrix: >
-        {
-          "os": [
-            ["self-hosted", "X64"],
-            ["self-hosted", "ARM64"],
-            ["macos-13"],
-            ["windows-2019"],
-            ["macos-latest-xlarge"]
-          ]
-        }
-      custom_publish_matrix: >
-        {
-          "os": [
-            ["self-hosted", "X64"],
-            ["self-hosted", "ARM64"],
-            ["macos-13"],
-            ["windows-2019"],
-            ["macos-latest-xlarge"]
-          ]
-        }
-      github_prerelease: false
-      restrict_custom_actions: false

.husky/pre-commit

@@ -1 +0,0 @@
-node automation/check-npm-version.js && ts-node automation/check-doc.ts

.mocharc.js

@@ -2,9 +2,6 @@ module.exports = {
 	reporter: 'spec',
 	require: 'ts-node/register/transpile-only',
 	file: './tests/config-tests',
-	timeout: 48000,
-	// To test only, say, 'push.spec.ts', do it as follows so that
-	// requests are authenticated:
-	// spec: ['tests/auth/*.spec.ts', 'tests/**/deploy.spec.ts'],
+	timeout: 12000,
 	spec: 'tests/**/*.spec.ts',
 };

.resinci.yml

@@ -0,0 +1,17 @@
+---
+npm:
+  platforms:
+    - name: linux
+      os: ubuntu
+      architecture: x86_64
+      node_versions:
+        - "10"
+        - "12"
+        - "14"
+    - name: linux
+      os: alpine
+      architecture: x86_64
+      node_versions:
+        - "10"
+        - "12"
+        - "14"

CONTRIBUTING.md

@@ -14,7 +14,7 @@ The balena CLI is an open source project and your contribution is welcome!
 In order to ease development:
 
 * `npm run build:fast` skips some of the build steps for interactive testing, or
-* `npm run test:source` skips testing the standalone packages (which is rather slow)
+* `npm run test:source` skips testing the standalone zip packages (which is rather slow)
 * `./bin/balena-dev` uses `ts-node/register` to transpile on the fly.
 
 Before opening a PR, test your changes with `npm test`. Keep compatibility in mind, as the CLI is
@@ -105,72 +105,26 @@ npm run update balena-sdk ^13.0.0 major
 
 ## Editing documentation files (README, INSTALL, Reference website...)
 
-The `docs/balena-cli.md` file is automatically generated by running `npm run build:doc` (which also
+The `doc/cli.markdown` file is automatically generated by running `npm run build:doc` (which also
 runs as part of `npm run build`). That file is then pulled by scripts in the
 [balena-io/docs](https://github.com/balena-io/docs/) GitHub repo for publishing at the [CLI
 Documentation page](https://www.balena.io/docs/reference/cli/).
 
-The content sources for the auto generation of `docs/balena-cli.md` are:
+The content sources for the auto generation of `doc/cli.markdown` 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
+`doc/cli.markdown` by the `getCapitanoDoc()` function in
 [`automation/capitanodoc/capitanodoc.ts`](https://github.com/balena-io/balena-cli/blob/master/automation/capitanodoc/capitanodoc.ts).
 
-**IMPORTANT**
-
-The file [`capitanodoc.ts`](https://github.com/balena-io/balena-cli/blob/master/automation/capitanodoc/capitanodoc.ts) lists 
-commands to generate documentation from. At the moment, it's manually updated and maintained alphabetically. 
-
-To add a new command to be documented, 
-
-1. Find the resource which it is part of or create a new one. 
-2. List the location of the build file 
-3. Make sure to add your files in alphabetical order
-
-Once added, run the command `npm run build` to generate the documentation
-
 The `INSTALL*.md` and `TROUBLESHOOTING.md` files are also manually edited.
 
-## Patches folder
-
-The `patches` folder contains patch files created with the
-[patch-package](https://www.npmjs.com/package/patch-package) tool. Small code changes to
-third-party modules can be made by directly editing Javascript files under the `node_modules`
-folder and then running `patch-package` to create the patch files. The patch files are then
-applied immediately after `npm install`, through the `postinstall` script defined in
-`package.json`.
-
-The subfolders of the `patches` folder are documented in the
-[apply-patches.js](https://github.com/balena-io/balena-cli/blob/master/patches/apply-patches.js)
-script.
-
-To make changes to the patch files under the `patches` folder, **do not edit them directly,**
-not even for a "single character change" because the hash values in the patch files also need
-to be recomputed by `patch-packages`. Instead, edit the relevant files under `node_modules`
-directly, and then run `patch-packages` with the `--patch-dir` option to specify the subfolder
-where the patch should be saved. For example, edit `node_modules/exit-hook/index.js` and then
-run:
-
-```sh
-$ npx patch-package --patch-dir patches/all exit-hook
-```
-
-That said, these kinds of patches should be avoided in favour of creating pull requests
-upstream. Patch files create additional maintenance work over time as the patches need to be
-updated when the dependencies are updated, and they prevent the compounding community benefit
-that sharing fixes upstream have on open source projects like the balena CLI. The typical
-scenario where these patches are used is when the upstream maintainers are unresponsive or
-unwilling to merge the required fixes, the fixes are very small and specific to the balena CLI,
-and creating a fork of the upstream repo is likely to be more long-term effort than maintaining
-the patches.
-
 ## Windows
 
 Besides the regular npm installation dependencies, the `npm run build:installer` script
@@ -223,7 +177,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:
@@ -313,3 +267,4 @@ gotchas to bear in mind:
 	replace: `spec: 'tests/**/*.spec.ts',`
 
 	with: `spec: ['tests/auth/*.spec.ts', 'tests/**/deploy.spec.ts'],`
+

INSTALL-ADVANCED.md

@@ -8,8 +8,8 @@ There are 3 options to choose from to install balena's CLI:
 
 * [Executable Installer](#executable-installer): the easiest method on Windows and macOS, using the
   traditional graphical desktop application installers.
-* [Standalone tar.gz Package](#standalone-targz-package): these are plain tar.gz files with the balena CLI
-  bundled within. Available for all platforms: Linux, Windows, macOS.
+* [Standalone Zip Package](#standalone-zip-package): these are plain zip files with the balena CLI
+  executable in them: extract and run. Available for all platforms: Linux, Windows, macOS.
   Recommended also for scripted installation in CI (continuous integration) environments.
 * [NPM Installation](#npm-installation): recommended for Node.js developers who may be interested
   in integrating the balena CLI in their existing projects or workflow.
@@ -30,9 +30,9 @@ instructions:
 > If you would like to use WSL, follow the [installations instructions for
 > Linux](./INSTALL-LINUX.md) rather than Windows, as WSL consists of a Linux environment.
 
-If you had previously installed the CLI using a standalone tar package, it may be a good idea to
+If you had previously installed the CLI using a standalone zip package, it may be a good idea to
 check your system's `PATH` environment variable for duplicate entries, as the terminal will use the
-entry that comes first. Check the [Standalone tar.gz Package](#standalone-targz-package) instructions
+entry that comes first. Check the [Standalone Zip Package](#standalone-zip-package) instructions
 for how to modify the PATH variable.
 
 By default, the CLI is installed to the following folders:
@@ -40,19 +40,20 @@ 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 tar.gz Package
+## Standalone Zip Package
 
-1. Download the latest tar.gz file from the [releases page](https://github.com/balena-io/balena-cli/releases).
+1. Download the latest zip file from the [releases page](https://github.com/balena-io/balena-cli/releases).
    Look for a file name that ends with the word "standalone", for example:  
-   `balena-cli-vX.Y.Z-linux-x64-standalone.tar.gz`  ← _also for the Windows Subsystem for Linux_  
-   `balena-cli-vX.Y.Z-macOS-x64-standalone.tar.gz`
-   `balena-cli-vX.Y.Z-windows-x64-standalone.tar.gz`
+   `balena-cli-vX.Y.Z-linux-x64-standalone.zip`  ← _also for the Windows Subsystem for Linux_  
+   `balena-cli-vX.Y.Z-macOS-x64-standalone.zip`  
+   `balena-cli-vX.Y.Z-windows-x64-standalone.zip`
 
-2. Extract the tar.gz file contents to any folder you choose. The extracted contents will be a `balena` folder containing a `bin` subdirectory.
+2. Extract the zip file contents to any folder you choose. The extracted contents will include a
+   `balena-cli` folder.
 
-3. Add the `balena/bin` folder to the system's `PATH` environment variable.
+3. Add the `balena-cli` folder to the system's `PATH` environment variable.  
    See instructions for:
    [Linux](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix) |
    [macOS](https://www.architectryan.com/2012/10/02/add-to-the-path-on-mac-os-x-mountain-lion/#.Uydjga1dXDg) |
@@ -60,14 +61,14 @@ macOS:   | `/usr/local/src/balena-cli/` <br> `/usr/local/bin/balena`
 
 > * If you are using macOS 10.15 or later (Catalina, Big Sur), [check this known issue and
 >   workaround](https://github.com/balena-io/balena-cli/issues/2244).
-> * **Linux Alpine** and **Busybox:** the standalone tar.gz package is not currently compatible with
+> * **Linux Alpine** and **Busybox:** the standalone zip package is not currently compatible with
 >   these "compact" Linux distributions, because of the alternative C libraries they ship with.
 >   For these, consider the [NPM Installation](#npm-installation) option.
-> * Note that moving the `balena/bin/balena` executable out of the extracted `balena` folder on its own
+> * Note that moving the `balena` executable out of the extracted `balena-cli` folder on its own
 >   (e.g. moving it to `/usr/local/bin/balena`) will **not** work, as it depends on the other
->   folders and files also present in the `balena` folder.
+>   folders and files also present in the `balena-cli` folder.
 
-To update the CLI to a new version, download a new release tar.gz file and replace the previous
+To update the CLI to a new version, download a new release zip file and replace the previous
 installation folder. To uninstall, simply delete the folder and edit the PATH environment variable
 as described above.
 
@@ -77,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 23 and later are not yet fully supported.**
+> **The balena CLI currently requires Node.js version 10 (min 10.20.0) or 12.**  
+> **Versions 13 and later are not yet fully supported.**
 
 ### Install development tools
 
@@ -88,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 22
+$ nvm install 12
 ```
 
 The `curl` command line above uses
@@ -105,15 +106,15 @@ recommended.
 ```sh
 $ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
 $ . ~/.bashrc
-$ nvm install 22
+$ nvm install 12
 ```
 
 #### **Windows** (not WSL)
 
 Install:
 
+* Node.js v12 from the [Nodejs.org releases page](https://nodejs.org/en/download/releases/).
   * If you'd like the ability to switch between Node.js versions, install
-- Node.js v22 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:
@@ -144,7 +145,7 @@ container) in order to allow npm scripts like `postinstall` to be executed.
 
 ## Additional Dependencies
 
-The `balena device ssh`, `device detect`, `build`, `deploy` and `preload` commands may require
+The `balena ssh`, `scan`, `build`, `deploy` and `preload` commands may require
 additional software to be installed. Check the Additional Dependencies sections for each operating
 system:
 

INSTALL-LINUX.md

@@ -8,15 +8,15 @@ method.
 
 Selected operating system: **Linux**
 
-1. Download the latest tar.gz file from the [latest release
+1. Download the latest zip file from the [latest release
    page](https://github.com/balena-io/balena-cli/releases/latest). Look for a file name that ends
-   with "-standalone.tar.gz", for example:  
-   `balena-cli-vX.Y.Z-linux-x64-standalone.tar.gz`
+   with "-standalone.zip", for example:  
+   `balena-cli-vX.Y.Z-linux-x64-standalone.zip`
 
-2. Extract the tar.gz file contents to any folder you choose, for example `/home/james`.
-   The extracted contents will include a `balena/bin` folder.
+2. Extract the zip file contents to any folder you choose, for example `/home/james`.
+   The extracted contents will include a `balena-cli` folder.
 
-3. Add that folder (e.g. `/home/james/balena/bin`) to the `PATH` environment variable.
+3. Add that folder (e.g. `/home/james/balena-cli`) to the `PATH` environment variable.
    Check this [StackOverflow
    post](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix)
    for instructions. Close and reopen the terminal window so that the changes to `PATH`
@@ -27,13 +27,13 @@ Selected operating system: **Linux**
    * `balena version` - should print the CLI's version
    * `balena help` - should print a list of available commands
 
-To update the balena CLI to a new version, download a new release tar.gz file and replace the previous
+To update the balena CLI to a new version, download a new release zip file and replace the previous
 installation folder. To uninstall, simply delete the folder and edit the PATH environment variable
 as described above.
 
 ## sudo configuration
 
-A few CLI commands require execution through sudo, e.g. `sudo balena device detect`.  
+A few CLI commands require execution through sudo, e.g. `sudo balena scan`.  
 If your Linux distribution has an `/etc/sudoers` file that defines a `secure_path`
 setting, run `sudo visudo` to edit it and add the balena CLI's installation folder to
 the ***pre-existing*** `secure_path` setting, for example:
@@ -61,19 +61,19 @@ instructions](https://docs.docker.com/install/overview/) to install Docker on th
 workstation as the balena CLI. The [advanced installation
 options](./INSTALL-ADVANCED.md#additional-dependencies) document describes other possibilities.
 
-### balena device ssh
+### balena ssh
 
-The `balena device ssh` command requires the `ssh` command-line tool to be available. Most Linux
+The `balena ssh` command requires the `ssh` command-line tool to be available. Most Linux
 distributions will already have it installed. Otherwise, `sudo apt-get install openssh-client`
 should do the trick on Debian or Ubuntu.
 
-The `balena device ssh` command also requires an SSH key to be added to your balena account: see [SSH
+The `balena ssh` command also requires an SSH key to be added to your balena account: see [SSH
 Access documentation](https://www.balena.io/docs/learn/manage/ssh-access/). The `balena key*`
 command set can also be used to list and manage SSH keys: see `balena help -v`.
 
-### balena device detect
+### balena scan
 
-The `balena device detect` command requires a multicast DNS (mDNS) service like
+The `balena scan` command requires a multicast DNS (mDNS) service like
 [Avahi](https://en.wikipedia.org/wiki/Avahi_(software)), which is installed by default on most
 desktop Linux distributions. Otherwise, on Debian or Ubuntu, the installation command would be
 `sudo apt-get install avahi-daemon`.

INSTALL-MAC.md

@@ -7,8 +7,8 @@ Selected operating system: **macOS**
 
 1. Download the installer from the [latest release
    page](https://github.com/balena-io/balena-cli/releases/latest).
-   Look for a file name that ends with "-installer.pkg":
-   `balena-cli-vX.Y.Z-macOS-x64-installer.pkg`
+   Look for a file name that ends with "-installer.pkg":  
+   `balena-cli-vX.Y.Z-macOS-x64-installer.pkg`  
 
 2. Double click on the downloaded file to run the installer and follow the installer's
    instructions.
@@ -19,7 +19,7 @@ Selected operating system: **macOS**
    - On the terminal prompt, type `balena version` and hit Enter. It should display
      the version of the balena CLI that you have installed.
 
-No further steps are required to run most CLI commands. The `balena device ssh`, `build`, `deploy`
+No further steps are required to run most CLI commands. The `balena ssh`, `build`, `deploy`
 and `preload` commands may require additional software to be installed, as described
 in the next section.
 
@@ -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
@@ -41,9 +41,9 @@ instructions](https://docs.docker.com/install/overview/) to install Docker on th
 workstation as the balena CLI. The [advanced installation
 options](./INSTALL-ADVANCED.md#additional-dependencies) document describes other possibilities.
 
-### balena device ssh
+### balena ssh
 
-The `balena device ssh` command requires the `ssh` command-line tool to be available. To check whether
+The `balena ssh` command requires the `ssh` command-line tool to be available. To check whether
 it is already installed, run `ssh` on a Terminal window. If it is not yet installed, the options
 include:
 
@@ -52,7 +52,7 @@ include:
   Components → Command Line Tools → Install.
 * Or, install [Homebrew](https://brew.sh/), then `brew install openssh`
 
-The `balena device ssh` command also requires an SSH key to be added to your balena account: see [SSH
+The `balena ssh` command also requires an SSH key to be added to your balena account: see [SSH
 Access documentation](https://www.balena.io/docs/learn/manage/ssh-access/). The `balena key*`
 command set can also be used to list and manage SSH keys: see `balena help -v`.
 

INSTALL-WINDOWS.md

@@ -8,7 +8,7 @@ Selected operating system: **Windows**
 1. Download the installer from the [latest release
    page](https://github.com/balena-io/balena-cli/releases/latest).
    Look for a file name that ends with "-installer.exe":  
-   `balena-cli-vX.Y.Z-windows-x64-installer.exe`
+   `balena-cli-vX.Y.Z-windows-x64-installer.exe`  
 
 2. Double click on the downloaded file to run the installer and follow the installer's
    instructions.
@@ -19,7 +19,7 @@ Selected operating system: **Windows**
    - On the command prompt, type `balena version` and hit Enter. It should display
      the version of the balena CLI that you have installed.
 
-No further steps are required to run most CLI commands. The `balena device ssh`, `device detect`, `build`,
+No further steps are required to run most CLI commands. The `balena ssh`, `scan`, `build`,
 `deploy` and `preload` commands may require additional software to be installed, as
 described below.
 
@@ -34,9 +34,9 @@ instructions](https://docs.docker.com/install/overview/) to install Docker on th
 workstation as the balena CLI. The [advanced installation
 options](./INSTALL-ADVANCED.md#additional-dependencies) document describes other possibilities.
 
-### balena device ssh
+### balena ssh
 
-The `balena device ssh` command requires the `ssh` command-line tool to be available. Microsoft started
+The `balena ssh` command requires the `ssh` command-line tool to be available. Microsoft started
 distributing an SSH client with Windows 10, which is automatically installed through Windows
 Update. To check whether it is installed, run `ssh` on a Windows Command Prompt or PowerShell. It
 can also be [manually
@@ -44,13 +44,13 @@ installed](https://docs.microsoft.com/en-us/windows-server/administration/openss
 if needed. For older versions of Windows, there are several ssh/OpenSSH clients provided by 3rd
 parties.
 
-The `balena device ssh` command also requires an SSH key to be added to your balena account: see [SSH
+The `balena ssh` command also requires an SSH key to be added to your balena account: see [SSH
 Access documentation](https://www.balena.io/docs/learn/manage/ssh-access/). The `balena key*`
 command set can also be used to list and manage SSH keys: see `balena help -v`.
 
-### balena device detect
+### balena scan
 
-The `balena device detect` command requires a multicast DNS (mDNS) service like Apple's Bonjour.
+The `balena scan` command requires a multicast DNS (mDNS) service like Apple's Bonjour.
 Many Windows machines will already have this service installed, as it is bundled in popular
 applications such as Skype (Wikipedia lists [several others](https://en.wikipedia.org/wiki/Bonjour_(software))).
 Otherwise, Bonjour for Windows can be downloaded and installed from: https://support.apple.com/kb/DL999

MIGRATIONS.md

@@ -1,45 +0,0 @@
-## Migrating to balena CLI v22
-
-This guide outlines the changes introduced in balena CLI v22 and provides instructions for when and how to migrate.
-
----
-
-### For Installer Users (Windows .exe, macOS .pkg)
-
-If you are using the Windows executable (.exe) or macOS package (.pkg) installers, **no changes** are required for this update. You can continue to use the installers as before.
-
----
-
-### For npm Installation Users
-
-If you installed balena CLI via npm, **no changes** are required for this update. Your existing installation and update process remains the same.
-
----
-
-### For Standalone Installation Users
-
-Users of the standalone balena CLI will need to make the following adjustments:
-
-1.  **Archive Format Change**: The distribution archive format has changed from `.zip` to `.tar.gz`. You will need to use the `tar` command instead of `unzip` to extract the CLI.
-
-    * **Previous command (v21.x.x and older):**
-        ```bash
-        unzip balena-cli-v21.1.12-linux-x64-standalone.zip
-        ```
-    * **New command (v22.0.0 and newer):**
-        ```bash
-        tar -xzf balena-cli-v22.0.0-linux-x64-standalone.tar.gz
-        ```
-
-2.  **Executable Path Change**: The path to the balena CLI executable within the extracted folder has been updated.
-
-    * **Previous path (v21.x.x and older):**
-        ```
-        balena-cli/balena
-        ```
-    * **New path (v22.0.0 and newer):**
-        ```
-        balena/bin/balena
-        ```
-
-Please update your scripts and any aliases to reflect these changes if you are using the standalone version.

README.md

@@ -20,7 +20,13 @@ GitHub](https://github.com/balena-io/balena-cli/), and your contribution is also
 Check the [balena CLI installation instructions on
 GitHub](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md).
 
-Note for v22 Migration: If you are upgrading to balena CLI v22 from a previous standalone installation, please [see the v22 Migration Guide](https://github.com/balena-io/balena-cli/blob/master/MIGRATIONS.md) for installation changes.
+## Development
+
+You can build the CLI for testing during development like so:
+
+`npm install && npm run build`
+
+After the build is completed, run `bin/balena` to test your changes.
 
 ## Choosing a shell (command prompt/terminal)
 
@@ -90,9 +96,9 @@ HTTP(S) proxies can be configured through any of the following methods, in prece
 * The `HTTPS_PROXY` and/or `HTTP_PROXY` environment variables, in the same URL format as
   `BALENARC_PROXY`.
 
-### Proxy setup for balena device ssh
+### Proxy setup for balena ssh
 
-In order to work behind a proxy server, the `balena device ssh` command requires the
+In order to work behind a proxy server, the `balena ssh` command requires the
 [`proxytunnel`](http://proxytunnel.sourceforge.net/) package (command-line tool) to be installed.
 `proxytunnel` is available for Linux distributions like Ubuntu/Debian (`apt install proxytunnel`),
 and for macOS through [Homebrew](https://brew.sh/). Windows support is limited to the [Windows
@@ -112,7 +118,7 @@ The `BALENARC_NO_PROXY` variable may be used to exclude specified destinations f
 > * This feature requires CLI version 11.30.8 or later. In the case of the npm [installation
 >   option](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md), it also requires
 >   Node.js version 10.16.0 or later.
-> * To exclude a `balena device ssh` target from proxying (IP address or `.local` hostname), the
+> * To exclude a `balena ssh` target from proxying (IP address or `.local` hostname), the
 >   `--noproxy` option should be specified in addition to the `BALENARC_NO_PROXY` variable.
 
 By default (if `BALENARC_NO_PROXY` is not defined), all [private IPv4
@@ -146,7 +152,7 @@ To learn more, troubleshoot issues, or to contact us for support:
 
 * Check the [masterclass tutorials](https://www.balena.io/docs/learn/more/masterclasses/overview/)
 * Check our [FAQ / troubleshooting document](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md)
-* Ask us a question in the [balena forums](https://forums.balena.io/c/product-support)
+* Ask us a question through the [balenaCloud forum](https://forums.balena.io/c/balena-cloud)
 
 For CLI bug reports or feature requests, check the
 [CLI GitHub issues](https://github.com/balena-io/balena-cli/issues/).

TROUBLESHOOTING.md

@@ -31,7 +31,7 @@ command again.
 
 Check whether the SD card is locked (a physical switch on the side of the card).
 
-## I get `connect ETIMEDOUT` with `balena device tunnel`
+## I get `connect ETIMEDOUT` with `balena tunnel`
 
 Please update the CLI to the latest version. This issue was fixed in v12.38.5.
 For more details, see: https://github.com/balena-io/balena-cli/issues/2172
@@ -79,10 +79,10 @@ Try resetting the ownership by running:
 $ sudo chown -R <user> $HOME/.balena
 ```
 
-## Broken line wrapping / cursor behavior with `balena device ssh`
+## Broken line wrapping / cursor behavior with `balena ssh`
 
 Users sometimes come across broken line wrapping or cursor behavior in text terminals, for example
-when long command lines are typed in a `balena device ssh` session, or when using text editors like `vim`
+when long command lines are typed in a `balena ssh` session, or when using text editors like `vim`
 or `nano`. This is not something specific to the balena CLI, being also a commonly reported issue
 with standard remote terminal tools like `ssh` or `telnet`.  It is often a remote shell
 configuration issue (files like `/etc/profile`, `~/.bash_profile`, `~/.bash_login`, `~/.profile`
@@ -115,7 +115,7 @@ If nothing seems to help, consider also using a different client-side terminal a
 ## "Docker seems to be unavailable" error when using Windows Subsystem for Linux (WSL)
 
 When running on WSL, the recommendation is to install a CLI release for Linux, like the standalone
-tar.gz package for Linux. However, commands like "balena build" will, by default, attempt to reach the
+zip package for Linux. However, commands like "balena build" will, by default, attempt to reach the
 Docker daemon at the Unix socket path `/var/run/docker.sock`, while Docker Desktop for Windows uses
 a Windows named pipe at `//./pipe/docker_engine` (which the Linux CLI on WSL cannot use). A
 solution is:

automation/build-bin.ts

@@ -15,25 +15,38 @@
  * limitations under the License.
  */
 
-import { run as oclifRun } from '@oclif/core';
-import { exec, execFile } from 'child_process';
-import type { Stats } from 'fs';
+import type { JsonVersions } from '../lib/commands/version';
+
+import { run as oclifRun } from '@oclif/dev-cli';
+import * as archiver from 'archiver';
+import * as Bluebird from 'bluebird';
+import { execFile } from 'child_process';
+import * as filehound from 'filehound';
+import { Stats } from 'fs';
 import * as fs from 'fs-extra';
 import * as klaw from 'klaw';
+import * as _ from 'lodash';
 import * as path from 'path';
 import * as rimraf from 'rimraf';
+import * as semver from 'semver';
 import { promisify } from 'util';
-import { notarize } from '@electron/notarize';
 
-import { loadPackageJson, ROOT, whichSpawn } from './utils';
+import { stripIndent } from '../build/utils/lazy';
+import {
+	diffLines,
+	loadPackageJson,
+	ROOT,
+	StdOutTap,
+	whichSpawn,
+} from './utils';
 
 const execFileAsync = promisify(execFile);
-const execAsync = promisify(exec);
-const rimrafAsync = promisify(rimraf);
 
 export const packageJSON = loadPackageJson();
 export const version = 'v' + packageJSON.version;
 const arch = process.arch;
+const MSYS2_BASH =
+	process.env.MSYSSHELLPATH || 'C:\\msys64\\usr\\bin\\bash.exe';
 
 function dPath(...paths: string[]) {
 	return path.join(ROOT, 'dist', ...paths);
@@ -43,13 +56,15 @@ interface PathByPlatform {
 	[platform: string]: string;
 }
 
-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 standaloneZips: PathByPlatform = {
+	linux: dPath(`balena-cli-${version}-linux-${arch}-standalone.zip`),
+	darwin: dPath(`balena-cli-${version}-macOS-${arch}-standalone.zip`),
+	win32: dPath(`balena-cli-${version}-windows-${arch}-standalone.zip`),
+};
+
+const oclifInstallers: PathByPlatform = {
+	darwin: dPath('macos', `balena-${version}.pkg`),
+	win32: dPath('win', `balena-${version}-${arch}.exe`),
 };
 
 const renamedOclifInstallers: PathByPlatform = {
@@ -57,30 +72,249 @@ const renamedOclifInstallers: PathByPlatform = {
 	win32: dPath(`balena-cli-${version}-windows-${arch}-installer.exe`),
 };
 
-const getOclifStandaloneOriginalNames = async (): Promise<PathByPlatform> => {
-	const { stdout } = await execAsync('git rev-parse --short HEAD');
-	const sha = stdout.trim();
-	return {
-		linux: dPath(`balena-${version}-${sha}-linux-${arch}.tar.gz`),
-		darwin: dPath(`balena-${version}-${sha}-darwin-${arch}.tar.gz`),
-		win32: dPath(`balena-${version}-${sha}-win32-${arch}.tar.gz`),
+export const finalReleaseAssets: { [platform: string]: string[] } = {
+	win32: [standaloneZips['win32'], renamedOclifInstallers['win32']],
+	darwin: [standaloneZips['darwin'], renamedOclifInstallers['darwin']],
+	linux: [standaloneZips['linux']],
+};
+
+/**
+ * Given the output of `pkg` as a string (containing warning messages),
+ * diff it against previously saved output of known "safe" warnings.
+ * Throw an error if the diff is not empty.
+ */
+async function diffPkgOutput(pkgOut: string) {
+	const { monochrome } = await import('../tests/helpers');
+	const relSavedPath = path.join(
+		'tests',
+		'test-data',
+		'pkg',
+		`expected-warnings-${process.platform}.txt`,
+	);
+	const absSavedPath = path.join(ROOT, relSavedPath);
+	const ignoreStartsWith = [
+		'> pkg@',
+		'> Fetching base Node.js binaries',
+		'  fetched-',
+	];
+	const modulesRE =
+		process.platform === 'win32'
+			? /(?<=[ '])([A-Z]:)?\\.+?\\node_modules(?=\\)/
+			: /(?<=[ '])\/.+?\/node_modules(?=\/)/;
+	const buildRE =
+		process.platform === 'win32'
+			? /(?<=[ '])([A-Z]:)?\\.+\\build(?=\\)/
+			: /(?<=[ '])\/.+\/build(?=\/)/;
+
+	const cleanLines = (chunks: string | string[]) => {
+		const lines = typeof chunks === 'string' ? chunks.split('\n') : chunks;
+		return lines
+			.map((line: string) => monochrome(line)) // remove ASCII colors
+			.filter((line: string) => !/^\s*$/.test(line)) // blank lines
+			.filter((line: string) =>
+				ignoreStartsWith.every((i) => !line.startsWith(i)),
+			)
+			.map((line: string) => {
+				// replace absolute paths with relative paths
+				let replaced = line.replace(modulesRE, 'node_modules');
+				if (replaced === line) {
+					replaced = line.replace(buildRE, 'build');
+				}
+				return replaced;
+			});
 	};
-};
 
-const renamedOclifStandalone: PathByPlatform = {
-	linux: dPath(`balena-cli-${version}-linux-${arch}-standalone.tar.gz`),
-	darwin: dPath(`balena-cli-${version}-macOS-${arch}-standalone.tar.gz`),
-	win32: dPath(`balena-cli-${version}-windows-${arch}-standalone.tar.gz`),
-};
-
-export async function signFilesForNotarization() {
-	console.log('Signing files for notarization');
-	// If signFilesForNotarization is called on the test CI environment (which will not set CSC_LINK)
-	// then we skip the signing process.
-	if (process.platform !== 'darwin' || !process.env.CSC_LINK) {
-		console.log('Skipping signing for notarization');
-		return;
+	pkgOut = cleanLines(pkgOut).join('\n');
+	const { readFile } = (await import('fs')).promises;
+	const expectedOut = cleanLines(await readFile(absSavedPath, 'utf8')).join(
+		'\n',
+	);
+	if (expectedOut !== pkgOut) {
+		const sep =
+			'================================================================================';
+		const diff = diffLines(expectedOut, pkgOut);
+		const msg = `pkg output does not match expected output from "${relSavedPath}"
+Diff:
+${sep}
+${diff}
+${sep}
+Check whether the new or changed pkg warnings are safe to ignore, then update
+"${relSavedPath}"
+and share the result of your investigation as comments on the pull request.
+Hint: the fix is often a matter of updating the 'pkg.scripts' or 'pkg.assets'
+sections in the CLI's 'package.json' file, or a matter of updating the
+'buildPkg' function in 'automation/build-bin.ts'.  Sometimes it requires
+patching dependencies: See for example 'patches/all/open+7.0.2.patch'.
+${sep}
+`;
+		throw new Error(msg);
 	}
+}
+
+/**
+ * Call `pkg.exec` to generate the standalone zip file, capturing its warning
+ * messages (stdout and stderr) in order to call diffPkgOutput().
+ */
+async function execPkg(...args: any[]) {
+	const { exec: pkgExec } = await import('pkg');
+	const outTap = new StdOutTap(true);
+	try {
+		outTap.tap();
+		await (pkgExec as any)(...args);
+	} catch (err) {
+		outTap.untap();
+		console.log(outTap.stdoutBuf.join(''));
+		console.error(outTap.stderrBuf.join(''));
+		throw err;
+	}
+	outTap.untap();
+	await diffPkgOutput(outTap.allBuf.join(''));
+}
+
+/**
+ * Use the 'pkg' module to create a single large executable file with
+ * the contents of 'node_modules' and the CLI's javascript code.
+ * Also copy a number of native modules (binary '.node' files) that are
+ * compiled during 'npm install' to the 'build-bin' folder, alongside
+ * the single large executable file created by pkg. (This is necessary
+ * because of a pkg limitation that does not allow binary executables
+ * to be directly executed from inside another binary executable.)
+ */
+async function buildPkg() {
+	const args = [
+		'--target',
+		'host',
+		'--output',
+		'build-bin/balena',
+		'package.json',
+	];
+	console.log('=======================================================');
+	console.log(`execPkg ${args.join(' ')}`);
+	console.log(`cwd="${process.cwd()}" ROOT="${ROOT}"`);
+	console.log('=======================================================');
+
+	await execPkg(args);
+
+	const paths: Array<[string, string[], string[]]> = [
+		// [platform, [source path], [destination path]]
+		['*', ['open', 'xdg-open'], ['xdg-open']],
+		['*', ['opn', 'xdg-open'], ['xdg-open-402']],
+		['darwin', ['denymount', 'bin', 'denymount'], ['denymount']],
+	];
+	await Promise.all(
+		paths.map(([platform, source, dest]) => {
+			if (platform === '*' || platform === process.platform) {
+				// eg copy from node_modules/open/xdg-open to build-bin/xdg-open
+				return fs.copy(
+					path.join(ROOT, 'node_modules', ...source),
+					path.join(ROOT, 'build-bin', ...dest),
+				);
+			}
+		}),
+	);
+	const nativeExtensionPaths: string[] = await filehound
+		.create()
+		.paths(path.join(ROOT, 'node_modules'))
+		.ext(['node', 'dll'])
+		.find();
+
+	console.log(`\nCopying to build-bin:\n${nativeExtensionPaths.join('\n')}`);
+
+	await Promise.all(
+		nativeExtensionPaths.map((extPath) =>
+			fs.copy(
+				extPath,
+				extPath.replace(
+					path.join(ROOT, 'node_modules'),
+					path.join(ROOT, 'build-bin'),
+				),
+			),
+		),
+	);
+}
+
+/**
+ * Run some basic tests on the built pkg executable.
+ * TODO: test more than just `balena version -j`; integrate with the
+ * existing mocha/chai CLI command testing.
+ */
+async function testPkg() {
+	const pkgBalenaPath = path.join(
+		ROOT,
+		'build-bin',
+		process.platform === 'win32' ? 'balena.exe' : 'balena',
+	);
+	console.log(`Testing standalone package "${pkgBalenaPath}"...`);
+	// Run `balena version -j`, parse its stdout as JSON, and check that the
+	// reported Node.js major version matches semver.major(process.version)
+	let { stdout, stderr } = await execFileAsync(pkgBalenaPath, [
+		'version',
+		'-j',
+	]);
+	const { filterCliOutputForTests } = await import('../tests/helpers');
+	const filtered = filterCliOutputForTests({
+		err: stderr.split(/\r?\n/),
+		out: stdout.split(/\r?\n/),
+	});
+	stdout = filtered.out.join('\n');
+	stderr = filtered.err.join('\n');
+	let pkgNodeVersion = '';
+	let pkgNodeMajorVersion = 0;
+	try {
+		const balenaVersions: JsonVersions = JSON.parse(stdout);
+		pkgNodeVersion = balenaVersions['Node.js'];
+		pkgNodeMajorVersion = semver.major(pkgNodeVersion);
+	} catch (err) {
+		throw new Error(stripIndent`
+			Error parsing JSON output of "balena version -j": ${err}
+			Original output: "${stdout}"`);
+	}
+	if (semver.major(process.version) !== pkgNodeMajorVersion) {
+		throw new Error(
+			`Mismatched major version: built-in pkg Node version="${pkgNodeVersion}" vs process.version="${process.version}"`,
+		);
+	}
+	if (filtered.err.length > 0) {
+		const err = filtered.err.join('\n');
+		throw new Error(`"${pkgBalenaPath}": non-empty stderr "${err}"`);
+	}
+	console.log('Success! (standalone package test successful)');
+}
+
+/**
+ * Create the zip file for the standalone 'pkg' bundle previously created
+ * by the buildPkg() function in 'build-bin.ts'.
+ */
+async function zipPkg() {
+	const outputFile = standaloneZips[process.platform];
+	if (!outputFile) {
+		throw new Error(
+			`Standalone installer unavailable for platform "${process.platform}"`,
+		);
+	}
+	await fs.mkdirp(path.dirname(outputFile));
+	await new Promise((resolve, reject) => {
+		console.log(`Zipping standalone package to "${outputFile}"...`);
+
+		const archive = archiver('zip', {
+			zlib: { level: 7 },
+		});
+		archive.directory(path.join(ROOT, 'build-bin'), 'balena-cli');
+
+		const outputStream = fs.createWriteStream(outputFile);
+
+		outputStream.on('close', resolve);
+		outputStream.on('error', reject);
+
+		archive.on('error', reject);
+		archive.on('warning', console.warn);
+
+		archive.pipe(outputStream);
+		archive.finalize();
+	});
+}
+
+async function signFilesForNotarization() {
 	console.log('Deleting unneeded zip files...');
 	await new Promise((resolve, reject) => {
 		klaw('node_modules/')
@@ -88,10 +322,6 @@ export async function signFilesForNotarization() {
 				if (!item.stats.isFile()) {
 					return;
 				}
-				if (path.basename(item.path).endsWith('.node.bak')) {
-					console.log('Removing pkg .node.bak file', item.path);
-					fs.unlinkSync(item.path);
-				}
 				if (
 					path.basename(item.path).endsWith('.zip') &&
 					path.dirname(item.path).includes('test')
@@ -166,40 +396,20 @@ export async function signFilesForNotarization() {
 	]);
 }
 
-export async function buildStandalone() {
-	console.log(`Building standalone tarball for CLI ${version}`);
-	fs.rmSync('./tmp', { recursive: true, force: true });
-	fs.rmSync('./dist', { recursive: true, force: true });
-	fs.mkdirSync('./dist');
+export async function buildStandaloneZip() {
+	console.log(`Building standalone zip package for CLI ${version}`);
 	try {
-		let packOpts = ['-r', ROOT, '--no-xz'];
-		if (process.platform === 'darwin') {
-			packOpts = packOpts.concat('--targets', `darwin-${arch}`);
-		} else if (process.platform === 'win32') {
-			packOpts = packOpts.concat('--targets', 'win32-x64');
-		} else if (process.platform === 'linux') {
-			packOpts = packOpts.concat('--targets', `linux-${arch}`);
-		}
-
-		console.log(`Building oclif installer for CLI ${version}`);
-		const packCmd = `pack:tarballs`;
-		console.log('=======================================================');
-		console.log(`oclif ${packCmd} ${packOpts.join(' ')}`);
-		console.log(`cwd="${process.cwd()}" ROOT="${ROOT}"`);
-		console.log('=======================================================');
-		const oclifPath = path.join(ROOT, 'node_modules', 'oclif');
-		await oclifRun([packCmd].concat(...packOpts), oclifPath);
-		await renameStandalone();
-
-		console.log(`Standalone tarball package build completed`);
+		await buildPkg();
+		await testPkg();
+		await zipPkg();
+		console.log(`Standalone zip package build completed`);
 	} catch (error) {
-		console.error(`Error creating or testing standalone tarball package`);
+		console.error(`Error creating or testing standalone zip package`);
 		throw error;
 	}
 }
 
-async function renameInstallers() {
-	const oclifInstallers = await getOclifInstallersOriginalNames();
+async function renameInstallerFiles() {
 	if (await fs.pathExists(oclifInstallers[process.platform])) {
 		await fs.rename(
 			oclifInstallers[process.platform],
@@ -208,42 +418,22 @@ async function renameInstallers() {
 	}
 }
 
-async function renameStandalone() {
-	const oclifStandalone = await getOclifStandaloneOriginalNames();
-	if (await fs.pathExists(oclifStandalone[process.platform])) {
-		await fs.rename(
-			oclifStandalone[process.platform],
-			renamedOclifStandalone[process.platform],
-		);
-	}
-}
-
 /**
  * If the CSC_LINK and CSC_KEY_PASSWORD env vars are set, digitally sign the
- * executable installer using Microsoft SignTool.exe (Sign Tool)
- * https://learn.microsoft.com/en-us/dotnet/framework/tools/signtool-exe
+ * executable installer by running the balena-io/scripts/shared/sign-exe.sh
+ * script (which must be in the PATH) using a MSYS2 bash shell.
  */
 async function signWindowsInstaller() {
-	if (process.env.SM_CODE_SIGNING_CERT_SHA1_HASH) {
-		const exeName = (await getOclifInstallersOriginalNames())[process.platform];
+	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',
-			process.env.TIMESTAMP_SERVER || 'http://timestamp.comodoca.com',
-			'-td',
-			'SHA256',
-			'-fd',
-			'SHA256',
+		await execFileAsync(MSYS2_BASH, [
+			'sign-exe.sh',
+			'-f',
+			exeName,
 			'-d',
 			`balena-cli ${version}`,
-			exeName,
 		]);
-		// ... but verify
-		await execFileAsync('signtool.exe', ['verify', '-pa', '-v', exeName]);
 	} else {
 		console.log(
 			'Skipping installer signing step because CSC_* env vars are not set',
@@ -255,26 +445,18 @@ async function signWindowsInstaller() {
  * Wait for Apple Installer Notarization to continue
  */
 async function notarizeMacInstaller(): Promise<void> {
-	const teamId = process.env.XCODE_APP_LOADER_TEAM_ID || '66H43P8FRG';
-	const appleId =
-		process.env.XCODE_APP_LOADER_EMAIL || 'accounts+apple@balena.io';
-	const appleIdPassword = process.env.XCODE_APP_LOADER_PASSWORD;
-	const appPath = (await getOclifInstallersOriginalNames())[process.platform];
-	console.log(`Notarizing file "${appPath}"`);
-
-	if (appleIdPassword && teamId) {
-		await notarize({
-			tool: 'notarytool',
-			teamId,
-			appPath,
-			appleId,
-			appleIdPassword,
-		});
-	}
+	const appleId = 'accounts+apple@balena.io';
+	const { notarize } = await import('electron-notarize');
+	await notarize({
+		appBundleId: 'io.balena.etcher',
+		appPath: renamedOclifInstallers.darwin,
+		appleId,
+		appleIdPassword: '@keychain:CLI_PASSWORD',
+	});
 }
 
 /**
- * Run the `oclif pack:win` or `pack:macos` command (depending on the value
+ * Run the `oclif-dev pack:win` or `pack:macos` command (depending on the value
  * of process.platform) to generate the native installers (which end up under
  * the 'dist' folder). There are some harcoded options such as selecting only
  * 64-bit binaries under Windows.
@@ -284,10 +466,9 @@ export async function buildOclifInstaller() {
 	let packOpts = ['-r', ROOT];
 	if (process.platform === 'darwin') {
 		packOS = 'macos';
-		packOpts = packOpts.concat('--targets', `darwin-${arch}`);
 	} else if (process.platform === 'win32') {
 		packOS = 'win';
-		packOpts = packOpts.concat('--targets', 'win32-x64');
+		packOpts = packOpts.concat('-t', 'win32-x64');
 	}
 	if (packOS) {
 		console.log(`Building oclif installer for CLI ${version}`);
@@ -298,14 +479,18 @@ export async function buildOclifInstaller() {
 		}
 		for (const dir of dirs) {
 			console.log(`rimraf(${dir})`);
-			await rimrafAsync(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(`oclif-dev "${packCmd}" "${packOpts.join('" "')}"`);
 		console.log(`cwd="${process.cwd()}" ROOT="${ROOT}"`);
 		console.log('=======================================================');
-		const oclifPath = path.join(ROOT, 'node_modules', 'oclif');
-		await oclifRun([packCmd].concat(...packOpts), oclifPath);
+		await oclifRun([packCmd].concat(...packOpts));
+		await renameInstallerFiles();
 		// The Windows installer is explicitly signed here (oclif doesn't do it).
 		// The macOS installer is automatically signed by oclif (which runs the
 		// `pkgbuild` tool), using the certificate name given in package.json
@@ -317,7 +502,6 @@ export async function buildOclifInstaller() {
 			await notarizeMacInstaller(); // Notarize
 			console.log('Package notarized.');
 		}
-		await renameInstallers();
 		console.log(`oclif installer build completed`);
 	}
 }
@@ -353,5 +537,4 @@ export async function testShrinkwrap(): Promise<void> {
 	if (process.platform !== 'win32') {
 		await whichSpawn(path.resolve(__dirname, 'test-lock-deduplicated.sh'));
 	}
-	await Promise.resolve();
 }

automation/capitanodoc/capitanodoc.ts

@@ -17,7 +17,6 @@
 
 import * as path from 'path';
 import { MarkdownFileParser } from './utils';
-import { GlobSync } from 'glob';
 
 /**
  * This is the skeleton of CLI documentation/reference web page at:
@@ -25,111 +24,180 @@ import { GlobSync } from 'glob';
  *
  * The `getCapitanoDoc` function in this module parses README.md and adds
  * some content to this object.
- *
- * IMPORTANT
- *
- * All commands need to be stored under a folder in src/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.
- *
- * This dictionary is the source of truth that creates the docs config which is used
- * to generate the CLI documentation. By default, the folder name will be used.
- *
  */
-
-interface Category {
-	title: string;
-	files: string[];
-}
-
-interface Documentation {
-	title: string;
-	introduction: string;
-	categories: Category[];
-}
-
-// Mapping folders names to custom headings in the docs
-const commandHeadings: { [key: string]: string } = {
-	'api-key': 'API Keys',
-	login: 'Authentication',
-	whoami: 'Authentication',
-	logout: 'Authentication',
-	env: 'Environment Variables',
-	help: 'Help and Version',
-	'ssh-key': 'SSH Keys',
-	organization: 'Organizations',
-	os: 'OS',
-	util: 'Utilities',
-	build: 'Deploy',
-	join: 'Platform',
-	leave: 'Platform',
-	app: 'Apps',
-	block: 'Blocks',
-	device: 'Devices',
-	fleet: 'Fleets',
-	release: 'Releases',
-	tag: 'Tags',
-};
-
-// Fetch all available commands
-const allCommandsPaths = new GlobSync('build/commands/**/*.js', {
-	ignore: 'build/commands/internal/**',
-}).found;
-
-// Throw error if any commands found outside of command directories
-const illegalCommandPaths = allCommandsPaths.filter((commandPath: string) =>
-	/^build\/commands\/[^/]+\.js$/.test(commandPath),
-);
-
-if (illegalCommandPaths.length !== 0) {
-	throw new Error(
-		`Found the following commands without a command directory: ${illegalCommandPaths}\n
-		To resolve this error, move the respective commands to their resource directories or create new ones.\n
-		Refer to the automation/capitanodoc/capitanodoc.ts file for more information.`,
-	);
-}
-
-// Docs config template
-const capitanoDoc: Documentation = {
+const capitanoDoc = {
 	title: 'balena CLI Documentation',
 	introduction: '',
-	categories: [],
+	categories: [
+		{
+			title: 'API keys',
+			files: ['build/commands/api-key/generate.js'],
+		},
+		{
+			title: 'Fleet',
+			files: [
+				'build/commands/apps.js',
+				'build/commands/fleets.js',
+				'build/commands/app/index.js',
+				'build/commands/fleet/index.js',
+				'build/commands/app/create.js',
+				'build/commands/fleet/create.js',
+				'build/commands/app/purge.js',
+				'build/commands/fleet/purge.js',
+				'build/commands/app/rename.js',
+				'build/commands/fleet/rename.js',
+				'build/commands/app/restart.js',
+				'build/commands/fleet/restart.js',
+				'build/commands/app/rm.js',
+				'build/commands/fleet/rm.js',
+			],
+		},
+		{
+			title: 'Authentication',
+			files: [
+				'build/commands/login.js',
+				'build/commands/logout.js',
+				'build/commands/whoami.js',
+			],
+		},
+		{
+			title: 'Device',
+			files: [
+				'build/commands/devices/index.js',
+				'build/commands/devices/supported.js',
+				'build/commands/device/index.js',
+				'build/commands/device/deactivate.js',
+				'build/commands/device/identify.js',
+				'build/commands/device/init.js',
+				'build/commands/device/local-mode.js',
+				'build/commands/device/move.js',
+				'build/commands/device/os-update.js',
+				'build/commands/device/public-url.js',
+				'build/commands/device/purge.js',
+				'build/commands/device/reboot.js',
+				'build/commands/device/register.js',
+				'build/commands/device/rename.js',
+				'build/commands/device/restart.js',
+				'build/commands/device/rm.js',
+				'build/commands/device/shutdown.js',
+			],
+		},
+		{
+			title: 'Releases',
+			files: [
+				'build/commands/releases.js',
+				'build/commands/release/index.js',
+				'build/commands/release/finalize.js',
+			],
+		},
+		{
+			title: 'Environment Variables',
+			files: [
+				'build/commands/envs.js',
+				'build/commands/env/add.js',
+				'build/commands/env/rename.js',
+				'build/commands/env/rm.js',
+			],
+		},
+		{
+			title: 'Tags',
+			files: [
+				'build/commands/tags.js',
+				'build/commands/tag/rm.js',
+				'build/commands/tag/set.js',
+			],
+		},
+		{
+			title: 'Help and Version',
+			files: ['help', 'build/commands/version.js'],
+		},
+		{
+			title: 'Keys',
+			files: [
+				'build/commands/keys.js',
+				'build/commands/key/index.js',
+				'build/commands/key/add.js',
+				'build/commands/key/rm.js',
+			],
+		},
+		{
+			title: 'Logs',
+			files: ['build/commands/logs.js'],
+		},
+		{
+			title: 'Network',
+			files: [
+				'build/commands/scan.js',
+				'build/commands/ssh.js',
+				'build/commands/tunnel.js',
+			],
+		},
+		{
+			title: 'Notes',
+			files: ['build/commands/note.js'],
+		},
+		{
+			title: 'OS',
+			files: [
+				'build/commands/os/build-config.js',
+				'build/commands/os/configure.js',
+				'build/commands/os/versions.js',
+				'build/commands/os/download.js',
+				'build/commands/os/initialize.js',
+			],
+		},
+		{
+			title: 'Config',
+			files: [
+				'build/commands/config/generate.js',
+				'build/commands/config/inject.js',
+				'build/commands/config/read.js',
+				'build/commands/config/reconfigure.js',
+				'build/commands/config/write.js',
+			],
+		},
+		{
+			title: 'Preload',
+			files: ['build/commands/preload.js'],
+		},
+		{
+			title: 'Push',
+			files: ['build/commands/push.js'],
+		},
+		{
+			title: 'Settings',
+			files: ['build/commands/settings.js'],
+		},
+		{
+			title: 'Local',
+			files: [
+				'build/commands/local/configure.js',
+				'build/commands/local/flash.js',
+			],
+		},
+		{
+			title: 'Deploy',
+			files: ['build/commands/build.js', 'build/commands/deploy.js'],
+		},
+		{
+			title: 'Platform',
+			files: ['build/commands/join.js', 'build/commands/leave.js'],
+		},
+		{
+			title: 'Utilities',
+			files: ['build/commands/util/available-drives.js'],
+		},
+		{
+			title: 'Support',
+			files: ['build/commands/support.js'],
+		},
+	],
 };
 
-// Helper function to capitalize each word of directory name
-function formatTitle(dir: string): string {
-	return dir.replace(/(^\w|\s\w)/g, (word) => word.toUpperCase());
-}
-
-// Create a map to track the categories for faster lookup
-const categoriesMap: { [key: string]: Category } = {};
-
-for (const commandPath of allCommandsPaths) {
-	const commandDir = path.basename(path.dirname(commandPath));
-	const heading = commandHeadings[commandDir] || formatTitle(commandDir);
-
-	if (!categoriesMap[heading]) {
-		categoriesMap[heading] = { title: heading, files: [] };
-		capitanoDoc.categories.push(categoriesMap[heading]);
-	}
-
-	categoriesMap[heading].files.push(commandPath);
-}
-
-// Sort Category titles alphabetically
-capitanoDoc.categories = capitanoDoc.categories.sort((a, b) =>
-	a.title.localeCompare(b.title),
-);
-
-// Sort Category file paths alphabetically
-capitanoDoc.categories.forEach((category) => {
-	category.files.sort((a, b) => a.localeCompare(b));
-});
-
 /**
- * Modify and return the `capitanoDoc` object above in order to generate the
- * CLI documentation at docs/balena-cli.md
+ * Modify and return the `capitanoDoc` object above in order to render the
+ * CLI documentation/reference web page at:
+ * https://www.balena.io/docs/reference/cli/
  *
  * This function parses the README.md file to extract relevant sections
  * for the documentation web page.
@@ -145,7 +213,7 @@ export async function getCapitanoDoc(): Promise<typeof capitanoDoc> {
 				throw new Error(`Error parsing section title`);
 			}
 			// match[1] has the title, match[2] has the rest
-			return match?.[2];
+			return match && match[2];
 		}),
 		mdParser.getSectionOfTitle('Installation'),
 		mdParser.getSectionOfTitle('Choosing a shell (command prompt/terminal)'),

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/command';
 
 type OclifCommand = typeof OclifCommandClass;
 
@@ -26,7 +26,7 @@ export interface Document {
 
 export interface Category {
 	title: string;
-	commands: Array<OclifCommand & { name: string }>;
+	commands: OclifCommand[];
 }
 
 export { OclifCommand };

automation/capitanodoc/index.ts

@@ -16,8 +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 '../../lib/utils/lazy';
 
 /**
  * Generates the markdown document (as a string) for the CLI documentation
@@ -38,7 +39,7 @@ export async function renderMarkdown(): Promise<string> {
 		};
 
 		for (const jsFilename of commandCategory.files) {
-			category.commands.push(await importOclifCommands(jsFilename));
+			category.commands.push(...importOclifCommands(jsFilename));
 		}
 		result.categories.push(category);
 	}
@@ -46,23 +47,49 @@ export async function renderMarkdown(): Promise<string> {
 	return markdown.render(result);
 }
 
-async function importOclifCommands(jsFilename: string) {
-	const command = (await import(path.join(process.cwd(), jsFilename)))
-		.default as OclifCommand;
+// Help is now managed via a plugin
+// This fake command allows capitanodoc to include help in docs
+class FakeHelpCommand {
+	description = stripIndent`
+		List balena commands, or get detailed help for a specific command.
 
-	return {
-		...command,
-		// build/commands/device/index.js -> device
-		// build/commands/device/list.js -> device list
-		name: jsFilename
-			.split('/')
-			.slice(2)
-			.join(' ')
-			.split('.')
-			.slice(0, 1)
-			.join(' ')
-			.split(' index')[0],
-	} as Category['commands'][0];
+		List balena commands, or get detailed help for a specific command.
+	`;
+
+	examples = [
+		'$ balena help',
+		'$ balena help login',
+		'$ balena help os download',
+	];
+
+	args = [
+		{
+			name: 'command',
+			description: 'command to show help for',
+		},
+	];
+
+	usage = 'help [command]';
+
+	flags = {
+		verbose: {
+			description: 'show additional commands',
+			char: '-v',
+		},
+	};
+}
+
+function importOclifCommands(jsFilename: string): OclifCommand[] {
+	// TODO: Currently oclif commands with no `usage` overridden will cause
+	//  an error when parsed.  This should be improved so that `usage` does not have
+	//  to be overridden if not necessary.
+
+	const command: OclifCommand =
+		jsFilename === 'help'
+			? (new FakeHelpCommand() as unknown as OclifCommand)
+			: (require(path.join(process.cwd(), jsFilename)).default as OclifCommand);
+
+	return [command];
 }
 
 /**
@@ -78,5 +105,4 @@ async function printMarkdown() {
 	}
 }
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
 printMarkdown();

automation/capitanodoc/markdown.ts

@@ -14,31 +14,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Parser } from '@oclif/core';
+import { flagUsages } from '@oclif/parser';
 import * as ent from 'ent';
 import * as _ from 'lodash';
 
-import { capitanoizeOclifUsage } from '../../src/utils/oclif-utils';
-import type { Category, Document } 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: Category['commands'][0]): string[] {
-	const result = [`## ${ent.encode(command.name || '')}`];
-	if (command.aliases?.length) {
-		result.push('### Aliases');
-		result.push(
-			command.aliases
-				.map(
-					(alias) =>
-						`- \`${alias}\`${command.deprecateAliases ? ' *(deprecated)*' : ''}`,
-				)
-				.join('\n'),
-		);
-		result.push(
-			`\nTo use one of the aliases, replace \`${command.name}\` with the alias.`,
-		);
-	}
-
-	result.push('### Description');
+function renderOclifCommand(command: OclifCommand): string[] {
+	const result = [`## ${ent.encode(command.usage || '')}`];
 	const description = (command.description || '')
 		.split('\n')
 		.slice(1) // remove the first line, which oclif uses as help header
@@ -52,8 +37,8 @@ function renderOclifCommand(command: Category['commands'][0]): string[] {
 
 	if (!_.isEmpty(command.args)) {
 		result.push('### Arguments');
-		for (const [name, arg] of Object.entries(command.args!)) {
-			result.push(`#### ${name.toUpperCase()}`, arg.description || '');
+		for (const arg of command.args!) {
+			result.push(`#### ${arg.name.toUpperCase()}`, arg.description || '');
 		}
 	}
 
@@ -64,7 +49,7 @@ function renderOclifCommand(command: Category['commands'][0]): string[] {
 				continue;
 			}
 			flag.name = name;
-			const flagUsage = Parser.flagUsages([flag])
+			const flagUsage = flagUsages([flag])
 				.map(([usage, _description]) => usage)
 				.join()
 				.trim();
@@ -95,7 +80,7 @@ function renderToc(categories: Category[]): string[] {
 		result.push(
 			category.commands
 				.map((command) => {
-					const signature = capitanoizeOclifUsage(command.name);
+					const signature = capitanoizeOclifUsage(command.usage);
 					return `\t- [${ent.encode(signature)}](${getAnchor(signature)})`;
 				})
 				.join('\n'),
@@ -104,7 +89,33 @@ function renderToc(categories: Category[]): string[] {
 	return result;
 }
 
+const manualCategorySorting: { [category: string]: string[] } = {
+	'Environment Variables': ['envs', 'env rm', 'env add', 'env rename'],
+	OS: [
+		'os versions',
+		'os download',
+		'os build config',
+		'os configure',
+		'os initialize',
+	],
+};
+
+function sortCommands(doc: Document): void {
+	for (const category of doc.categories) {
+		if (category.title in manualCategorySorting) {
+			category.commands = category.commands.sort(
+				getManualSortCompareFunction<OclifCommand, string>(
+					manualCategorySorting[category.title],
+					(cmd: OclifCommand, x: string) =>
+						(cmd.usage || '').toString().replace(/\W+/g, ' ').includes(x),
+				),
+			);
+		}
+	}
+}
+
 export function render(doc: Document) {
+	sortCommands(doc);
 	const result = [
 		`# ${doc.title}`,
 		doc.introduction,

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.js

@@ -15,25 +15,24 @@
  * limitations under the License.
  */
 
-// eslint-disable-next-line no-restricted-imports
-import { stripIndent } from 'common-tags';
-import * as _ from 'lodash';
-import { promises as fs } from 'fs';
-import * as path from 'path';
-import { simpleGit } from 'simple-git';
+const stripIndent = require('common-tags/lib/stripIndent');
+const _ = require('lodash');
+const { promises: fs } = require('fs');
+const path = require('path');
+const simplegit = require('simple-git/promise');
 
 const ROOT = path.normalize(path.join(__dirname, '..'));
 
 /**
- * Compare the timestamp of balena-cli.md with the timestamp of staged files,
- * issuing an error if balena-cli.md is older.
- * If balena-cli.md does not require updating and the developer cannot run
+ * Compare the timestamp of cli.markdown with the timestamp of staged files,
+ * issuing an error if cli.markdown is older.
+ * If cli.markdown does not require updating and the developer cannot run
  * `npm run build` on their laptop, the error message suggests a workaround
  * using `touch`.
  */
 async function checkBuildTimestamps() {
-	const git = simpleGit(ROOT);
-	const docFile = path.join(ROOT, 'docs', 'balena-cli.md');
+	const git = simplegit(ROOT);
+	const docFile = path.join(ROOT, 'doc', 'cli.markdown');
 	const [docStat, gitStatus] = await Promise.all([
 		fs.stat(docFile),
 		git.status(),
@@ -43,8 +42,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)));
@@ -82,5 +81,4 @@ async function run() {
 	}
 }
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
 run();

automation/check-npm-version.js

@@ -6,8 +6,6 @@
  *
  * We don't `require('semver')` to allow this script to be run as a npm
  * 'preinstall' hook, at which point no dependencies have been installed.
- *
- * @param {string} version
  */
 function parseSemver(version) {
 	const match = /v?(\d+)\.(\d+).(\d+)/.exec(version);
@@ -18,13 +16,9 @@ function parseSemver(version) {
 	return [parseInt(major, 10), parseInt(minor, 10), parseInt(patch, 10)];
 }
 
-/**
- * @param {string} v1
- * @param {string} v2
- */
 function semverGte(v1, v2) {
-	const v1Array = parseSemver(v1);
-	const v2Array = parseSemver(v2);
+	let v1Array = parseSemver(v1);
+	let v2Array = parseSemver(v2);
 	for (let i = 0; i < 3; i++) {
 		if (v1Array[i] < v2Array[i]) {
 			return false;

automation/deploy-bin.ts

@@ -0,0 +1,257 @@
+/**
+ * @license
+ * Copyright 2019 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * 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],
+		}),
+	);
+	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 = (
+		require('@octokit/rest') as typeof import('@octokit/rest')
+	).Octokit.plugin(
+		(
+			require('@octokit/plugin-throttling') as typeof import('@octokit/plugin-throttling')
+		).throttling,
+	);
+	return new Octokit({
+		auth: GITHUB_TOKEN,
+		throttle: {
+			onRateLimit: (retryAfter: number, options: any) => {
+				console.warn(
+					`Request quota exhausted for request ${options.method} ${options.url}`,
+				);
+				// retries 3 times
+				if (options.request.retryCount < 3) {
+					console.log(`Retrying after ${retryAfter} seconds!`);
+					return true;
+				}
+			},
+			onAbuseLimit: (_retryAfter: number, options: any) => {
+				// does not retry, only logs a warning
+				console.warn(
+					`Abuse detected for request ${options.method} ${options.url}`,
+				);
+			},
+		},
+	});
+});
+
+/**
+ * Extract pagination information (current page, total pages, ordinal number)
+ * from the 'link' response header (example below), using the parse-link-header
+ * npm package:
+ * "link": "<https://api.github.com/repositories/187370853/releases?per_page=2&page=2>; rel=\"next\",
+ *          <https://api.github.com/repositories/187370853/releases?per_page=2&page=3>; rel=\"last\""
+ *
+ * @param response Octokit response object (including response.headers.link)
+ * @param perPageDefault Default per_page pagination value if missing in URL
+ * @return Object where 'page' is the current page number (1-based),
+ * 'pages' is the total number of pages, and 'ordinal' is the ordinal number
+ * (3rd, 4th, 5th...) of the first item in the current page.
+ */
+function getPageNumbers(
+	response: any,
+	perPageDefault: number,
+): { page: number; pages: number; ordinal: number } {
+	const res = { page: 1, pages: 1, ordinal: 1 };
+	if (!response.headers.link) {
+		return res;
+	}
+	const parse =
+		require('parse-link-header') as typeof import('parse-link-header');
+	const parsed = parse(response.headers.link);
+	if (parsed == null) {
+		throw new Error(`Failed to parse link header: '${response.headers.link}'`);
+	}
+	let perPage = perPageDefault;
+	if (parsed.next) {
+		if (parsed.next.per_page) {
+			perPage = parseInt(parsed.next.per_page, 10);
+		}
+		res.page = parseInt(parsed.next.page, 10) - 1;
+		res.pages = parseInt(parsed.last.page, 10);
+	} else {
+		if (parsed.prev.per_page) {
+			perPage = parseInt(parsed.prev.per_page, 10);
+		}
+		res.page = res.pages = parseInt(parsed.prev.page, 10) + 1;
+	}
+	res.ordinal = (res.page - 1) * perPage + 1;
+	return res;
+}
+
+/**
+ * Iterate over every GitHub release in the given owner/repo, check whether
+ * its tag_name matches against the affectedVersions semver spec, and if so
+ * replace its release description (body) with the given newDescription value.
+ * @param owner GitHub repo owner, e.g. 'balena-io' or 'pdcastro'
+ * @param repo GitHub repo, e.g. 'balena-cli'
+ * @param affectedVersions Semver spec, e.g. '2.6.1 - 7.10.9 || 8.0.0'
+ * @param newDescription New release description (body)
+ * @param editID Short string present in newDescription, e.g. '[AA101]', that
+ * can be searched to determine whether that release has already been updated.
+ */
+async function updateGitHubReleaseDescriptions(
+	owner: string,
+	repo: string,
+	affectedVersions: string,
+	newDescription: string,
+	editID: string,
+) {
+	const perPage = 30;
+	const octokit = getOctokit();
+	const options = await octokit.repos.listReleases.endpoint.merge({
+		owner,
+		repo,
+		per_page: perPage,
+	});
+	let errCount = 0;
+	type Release =
+		import('@octokit/rest').RestEndpointMethodTypes['repos']['listReleases']['response']['data'][0];
+	for await (const response of octokit.paginate.iterator<Release>(options)) {
+		const {
+			page: thisPage,
+			pages: totalPages,
+			ordinal,
+		} = getPageNumbers(response, perPage);
+		let i = 0;
+		for (const cliRelease of response.data) {
+			const prefix = `[#${ordinal + i++} pg ${thisPage}/${totalPages}]`;
+			if (!cliRelease.id) {
+				console.error(
+					`${prefix} Error: missing release ID (errCount=${++errCount})`,
+				);
+				continue;
+			}
+			const skipMsg = `${prefix} skipping release "${cliRelease.tag_name}" (${cliRelease.id})`;
+			if (cliRelease.draft === true) {
+				console.info(`${skipMsg}: draft release`);
+				continue;
+			} else if (cliRelease.body && cliRelease.body.includes(editID)) {
+				console.info(`${skipMsg}: already updated`);
+				continue;
+			} else if (!semver.satisfies(cliRelease.tag_name, affectedVersions)) {
+				console.info(`${skipMsg}: outside version range`);
+				continue;
+			} else {
+				const updatedRelease = {
+					owner,
+					repo,
+					release_id: cliRelease.id,
+					body: newDescription,
+				};
+				let oldBodyPreview = cliRelease.body;
+				if (oldBodyPreview) {
+					oldBodyPreview = oldBodyPreview.replace(/\s+/g, ' ').trim();
+					if (oldBodyPreview.length > 12) {
+						oldBodyPreview = oldBodyPreview.substring(0, 9) + '...';
+					}
+				}
+				console.info(
+					`${prefix} updating release "${cliRelease.tag_name}" (${cliRelease.id}) old body="${oldBodyPreview}"`,
+				);
+				try {
+					await octokit.repos.updateRelease(updatedRelease);
+				} catch (err) {
+					console.error(
+						`${skipMsg}: Error: ${err.message} (count=${++errCount})`,
+					);
+					continue;
+				}
+			}
+		}
+	}
+}
+
+/**
+ * Add a warning description to CLI releases affected by a mixpanel tracking
+ * security issue (#1359). This function can be executed "manually" with the
+ * following command line:
+ *
+ * npx ts-node --type-check -P automation/tsconfig.json automation/run.ts fix1359
+ */
+export async function updateDescriptionOfReleasesAffectedByIssue1359() {
+	// Run only on Linux/Node10, instead of all platform/Node combinations.
+	// (It could have been any other platform, as long as it only runs once.)
+	if (process.platform !== 'linux' || semver.major(process.version) !== 10) {
+		return;
+	}
+	const owner = 'balena-io';
+	const repo = 'balena-cli';
+	const affectedVersions =
+		'2.6.1 - 7.10.9 || 8.0.0 - 8.1.0 || 9.0.0 - 9.15.6 || 10.0.0 - 10.17.5 || 11.0.0 - 11.7.2';
+	const editID = '[AA100]';
+	let newDescription = `
+		Please note: the "login" command in this release is affected by a
+		security issue fixed in versions
+		[7.10.10](https://github.com/balena-io/balena-cli/releases/tag/v7.10.10),
+		[8.1.1](https://github.com/balena-io/balena-cli/releases/tag/v8.1.1),
+		[9.15.7](https://github.com/balena-io/balena-cli/releases/tag/v9.15.7),
+		[10.17.6](https://github.com/balena-io/balena-cli/releases/tag/v10.17.6),
+		[11.7.3](https://github.com/balena-io/balena-cli/releases/tag/v11.7.3)
+		and later. If you need to use this version, avoid passing your password,
+		keys or tokens as command-line arguments. ${editID}`;
+	// remove line breaks and collapse white space
+	newDescription = newDescription.replace(/\s+/g, ' ').trim();
+	await updateGitHubReleaseDescriptions(
+		owner,
+		repo,
+		affectedVersions,
+		newDescription,
+		editID,
+	);
+}

automation/run.ts

@@ -19,11 +19,14 @@ import * as _ from 'lodash';
 
 import {
 	buildOclifInstaller,
-	buildStandalone,
+	buildStandaloneZip,
 	catchUncommitted,
-	signFilesForNotarization,
 	testShrinkwrap,
 } from './build-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(
@@ -36,7 +39,8 @@ process.env.DEBUG = ['0', 'no', 'false', '', undefined].includes(
  * Trivial command-line parser. Check whether the command-line argument is one
  * of the following strings, then call the appropriate functions:
  *     'build:installer'   (to build a native oclif installer)
- * 	   'build:standalone'  (to build a standalone package)
+ * 	   '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))
  */
@@ -49,17 +53,33 @@ async function parse(args?: string[]) {
 	}
 	const commands: { [cmd: string]: () => void | Promise<void> } = {
 		'build:installer': buildOclifInstaller,
-		'build:standalone': buildStandalone,
-		'sign:binaries': signFilesForNotarization,
+		'build:standalone': buildStandaloneZip,
 		'catch-uncommitted': catchUncommitted,
 		'test-shrinkwrap': testShrinkwrap,
+		fix1359: updateDescriptionOfReleasesAffectedByIssue1359,
+		release,
 	};
 	for (const arg of args) {
-		if (!Object.hasOwn(commands, arg)) {
+		if (!commands.hasOwnProperty(arg)) {
 			throw new Error(`command unknown: ${arg}`);
 		}
 	}
 
+	// 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];
@@ -83,5 +103,4 @@ export async function run(args?: string[]) {
 	}
 }
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
 run();

automation/update-module.ts

@@ -3,7 +3,7 @@ import * as semver from 'semver';
 
 const changeTypes = ['major', 'minor', 'patch'] as const;
 
-const validateChangeType = (maybeChangeType = 'minor') => {
+const validateChangeType = (maybeChangeType: string = 'minor') => {
 	maybeChangeType = maybeChangeType.toLowerCase();
 	switch (maybeChangeType) {
 		case 'patch':
@@ -36,8 +36,8 @@ const run = async (cmd: string) => {
 			}
 			resolve({ stdout, stderr });
 		});
-		p.stdout?.pipe(process.stdout);
-		p.stderr?.pipe(process.stderr);
+		p.stdout.pipe(process.stdout);
+		p.stderr.pipe(process.stderr);
 	});
 };
 
@@ -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');
@@ -136,4 +136,4 @@ async function main() {
 	}
 }
 
-void main();
+main();

automation/utils.ts

@@ -16,17 +16,76 @@
  */
 
 import { spawn } from 'child_process';
+import * as _ from 'lodash';
 import * as path from 'path';
-import * as fs from 'fs';
-import * as whichMod from 'which';
 
 export const ROOT = path.join(__dirname, '..');
 
-export function loadPackageJson() {
-	const packageJsonPath = path.join(ROOT, 'package.json');
+/** Tap and buffer this process' stdout and stderr */
+export class StdOutTap {
+	public stdoutBuf: string[] = [];
+	public stderrBuf: string[] = [];
+	public allBuf: string[] = []; // both stdout and stderr
 
-	const packageJson = fs.readFileSync(packageJsonPath, 'utf8');
-	return JSON.parse(packageJson);
+	protected origStdoutWrite: typeof process.stdout.write;
+	protected origStderrWrite: typeof process.stdout.write;
+
+	constructor(protected printDots = false) {}
+
+	tap() {
+		this.origStdoutWrite = process.stdout.write;
+		this.origStderrWrite = process.stderr.write;
+
+		process.stdout.write = (chunk: string, ...args: any[]): boolean => {
+			this.stdoutBuf.push(chunk);
+			this.allBuf.push(chunk);
+			const str = this.printDots ? '.' : chunk;
+			return this.origStdoutWrite.call(process.stdout, str, ...args);
+		};
+
+		process.stderr.write = (chunk: string, ...args: any[]): boolean => {
+			this.stderrBuf.push(chunk);
+			this.allBuf.push(chunk);
+			const str = this.printDots ? '.' : chunk;
+			return this.origStderrWrite.call(process.stderr, str, ...args);
+		};
+	}
+
+	untap() {
+		process.stdout.write = this.origStdoutWrite;
+		process.stderr.write = this.origStderrWrite;
+		if (this.printDots) {
+			console.error('');
+		}
+	}
+}
+
+/**
+ * Diff strings by line, using the 'diff' npm package:
+ * https://www.npmjs.com/package/diff
+ */
+export function diffLines(str1: string, str2: string): string {
+	const { diffTrimmedLines } = require('diff');
+	const diffObjs = diffTrimmedLines(str1, str2);
+	const prefix = (chunk: string, char: string) =>
+		chunk
+			.split('\n')
+			.map((line: string) => `${char} ${line}`)
+			.join('\n');
+	const diffStr = diffObjs
+		.map((part: any) => {
+			return part.added
+				? prefix(part.value, '+')
+				: part.removed
+				? prefix(part.value, '-')
+				: prefix(part.value, ' ');
+		})
+		.join('\n');
+	return diffStr;
+}
+
+export function loadPackageJson() {
+	return require(path.join(ROOT, 'package.json'));
 }
 
 /**
@@ -39,6 +98,7 @@ export function loadPackageJson() {
  * @returns The program's full path, e.g. 'C:\WINDOWS\System32\OpenSSH\ssh.EXE'
  */
 export async function which(program: string): Promise<string> {
+	const whichMod = await import('which');
 	let programPath: string;
 	try {
 		programPath = await whichMod(program);
@@ -57,7 +117,7 @@ export async function which(program: string): Promise<string> {
  */
 export async function whichSpawn(
 	programName: string,
-	args: string[] = [],
+	args?: string[],
 ): Promise<void> {
 	const program = await which(programName);
 	let error: Error | undefined;
@@ -69,7 +129,7 @@ export async function whichSpawn(
 					.on('error', reject)
 					.on('close', resolve);
 			} catch (err) {
-				reject(err as Error);
+				reject(err);
 			}
 		});
 	} catch (err) {

bin/balena

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

bin/balena

@@ -0,0 +1,23 @@
+#!/usr/bin/env node
+
+// tslint:disable:no-var-requires
+
+// 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();
+}
+
+run();

bin/balena-dev

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

bin/balena-dev

@@ -0,0 +1,89 @@
+#!/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
+// ****************************************************************************
+
+// tslint:disable:no-var-requires
+
+// 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();
+
+// 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,90 +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,
-});
-void 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 });
-}
-
-void run();

completion/_balena

@@ -8,28 +8,26 @@ _balena() {
   local context state line curcontext="$curcontext"
 
   # Valid top-level completions
-  main_commands=( api-key app block build config deploy device device-type env fleet internal join leave local login logout organization os preload push release settings ssh-key support tag util version whoami )
+  main_commands=( apps build deploy envs fleets join keys leave login logout logs note orgs preload push releases scan settings ssh support tags tunnel version whoami api-key app app config device device devices env fleet fleet internal key key local os release release tag util )
   # Sub-completions
-  api_key_cmds=( generate list revoke )
-  app_cmds=( create )
-  block_cmds=( create )
+  api_key_cmds=( generate )
+  app_cmds=( create purge rename restart rm )
   config_cmds=( generate inject read reconfigure write )
-  device_type_cmds=( list )
-  device_cmds=( deactivate detect identify init list local-mode logs move note os-update pin public-url purge reboot register rename restart rm shutdown ssh start-service stop-service track-fleet tunnel )
-  env_cmds=( list rename rm set )
-  fleet_cmds=( create list pin purge rename restart rm track-latest )
+  device_cmds=( deactivate identify init local-mode move os-update public-url purge reboot register rename restart rm shutdown )
+  devices_cmds=( supported )
+  env_cmds=( add rename rm )
+  fleet_cmds=( create purge rename restart rm )
   internal_cmds=( osinit )
+  key_cmds=( add rm )
   local_cmds=( configure flash )
-  organization_cmds=( list )
   os_cmds=( build-config configure download initialize versions )
-  release_cmds=( finalize invalidate list validate )
-  ssh_key_cmds=( add list rm )
-  tag_cmds=( list rm set )
+  release_cmds=( finalize )
+  tag_cmds=( rm set )
 
 
   _arguments -C \
     '(- 1 *)--version[show version and exit]' \
-    '(- 1 *)--help[show help options and exit]' \
+    '(- 1 *)'{-h,--help}'[show help options and exit]' \
     '1:first command:_balena_main_cmds' \
     '2:second command:_balena_sec_cmds' \
   && ret=0
@@ -49,18 +47,15 @@ _balena_sec_cmds() {
       "app")
         _describe -t app_cmds 'app_cmd' app_cmds "$@" && ret=0
       ;;
-      "block")
-        _describe -t block_cmds 'block_cmd' block_cmds "$@" && ret=0
-      ;;
       "config")
         _describe -t config_cmds 'config_cmd' config_cmds "$@" && ret=0
       ;;
-      "device-type")
-        _describe -t device_type_cmds 'device-type_cmd' device_type_cmds "$@" && ret=0
-      ;;
       "device")
         _describe -t device_cmds 'device_cmd' device_cmds "$@" && ret=0
       ;;
+      "devices")
+        _describe -t devices_cmds 'devices_cmd' devices_cmds "$@" && ret=0
+      ;;
       "env")
         _describe -t env_cmds 'env_cmd' env_cmds "$@" && ret=0
       ;;
@@ -70,21 +65,18 @@ _balena_sec_cmds() {
       "internal")
         _describe -t internal_cmds 'internal_cmd' internal_cmds "$@" && ret=0
       ;;
+      "key")
+        _describe -t key_cmds 'key_cmd' key_cmds "$@" && ret=0
+      ;;
       "local")
         _describe -t local_cmds 'local_cmd' local_cmds "$@" && ret=0
       ;;
-      "organization")
-        _describe -t organization_cmds 'organization_cmd' organization_cmds "$@" && ret=0
-      ;;
       "os")
         _describe -t os_cmds 'os_cmd' os_cmds "$@" && ret=0
       ;;
       "release")
         _describe -t release_cmds 'release_cmd' release_cmds "$@" && ret=0
       ;;
-      "ssh-key")
-        _describe -t ssh_key_cmds 'ssh-key_cmd' ssh_key_cmds "$@" && ret=0
-      ;;
       "tag")
         _describe -t tag_cmds 'tag_cmd' tag_cmds "$@" && ret=0
       ;;

completion/balena-completion.bash

@@ -7,23 +7,21 @@ _balena_complete()
   local cur prev
 
   # Valid top-level completions
-  main_commands="api-key app block build config deploy device device-type env fleet internal join leave local login logout organization os preload push release settings ssh-key support tag util version whoami"
+  main_commands="apps build deploy envs fleets join keys leave login logout logs note orgs preload push releases scan settings ssh support tags tunnel version whoami api-key app app config device device devices env fleet fleet internal key key local os release release tag util"
   # Sub-completions
-  api_key_cmds="generate list revoke"
-  app_cmds="create"
-  block_cmds="create"
+  api_key_cmds="generate"
+  app_cmds="create purge rename restart rm"
   config_cmds="generate inject read reconfigure write"
-  device_type_cmds="list"
-  device_cmds="deactivate detect identify init list local-mode logs move note os-update pin public-url purge reboot register rename restart rm shutdown ssh start-service stop-service track-fleet tunnel"
-  env_cmds="list rename rm set"
-  fleet_cmds="create list pin purge rename restart rm track-latest"
+  device_cmds="deactivate identify init local-mode move os-update public-url purge reboot register rename restart rm shutdown"
+  devices_cmds="supported"
+  env_cmds="add rename rm"
+  fleet_cmds="create purge rename restart rm"
   internal_cmds="osinit"
+  key_cmds="add rm"
   local_cmds="configure flash"
-  organization_cmds="list"
   os_cmds="build-config configure download initialize versions"
-  release_cmds="finalize invalidate list validate"
-  ssh_key_cmds="add list rm"
-  tag_cmds="list rm set"
+  release_cmds="finalize"
+  tag_cmds="rm set"
 
 
 
@@ -43,18 +41,15 @@ _balena_complete()
       app)
         COMPREPLY=( $(compgen -W "$app_cmds" -- $cur) )
         ;;
-      block)
-        COMPREPLY=( $(compgen -W "$block_cmds" -- $cur) )
-        ;;
       config)
         COMPREPLY=( $(compgen -W "$config_cmds" -- $cur) )
         ;;
-      device-type)
-        COMPREPLY=( $(compgen -W "$device_type_cmds" -- $cur) )
-        ;;
       device)
         COMPREPLY=( $(compgen -W "$device_cmds" -- $cur) )
         ;;
+      devices)
+        COMPREPLY=( $(compgen -W "$devices_cmds" -- $cur) )
+        ;;
       env)
         COMPREPLY=( $(compgen -W "$env_cmds" -- $cur) )
         ;;
@@ -64,21 +59,18 @@ _balena_complete()
       internal)
         COMPREPLY=( $(compgen -W "$internal_cmds" -- $cur) )
         ;;
+      key)
+        COMPREPLY=( $(compgen -W "$key_cmds" -- $cur) )
+        ;;
       local)
         COMPREPLY=( $(compgen -W "$local_cmds" -- $cur) )
         ;;
-      organization)
-        COMPREPLY=( $(compgen -W "$organization_cmds" -- $cur) )
-        ;;
       os)
         COMPREPLY=( $(compgen -W "$os_cmds" -- $cur) )
         ;;
       release)
         COMPREPLY=( $(compgen -W "$release_cmds" -- $cur) )
         ;;
-      ssh-key)
-        COMPREPLY=( $(compgen -W "$ssh_key_cmds" -- $cur) )
-        ;;
       tag)
         COMPREPLY=( $(compgen -W "$tag_cmds" -- $cur) )
         ;;

completion/generate-completion.js

@@ -31,9 +31,9 @@ if (fs.existsSync(commandsFilePath)) {
 
 const commandsJson = JSON.parse(fs.readFileSync(commandsFilePath, 'utf8'));
 
-const mainCommands = [];
-const additionalCommands = [];
-for (const key of Object.keys(commandsJson.commands).sort()) {
+var mainCommands = [];
+var additionalCommands = [];
+for (const key of Object.keys(commandsJson.commands)) {
 	const cmd = key.split(':');
 	if (cmd.length > 1) {
 		additionalCommands.push(cmd);
@@ -72,8 +72,8 @@ fs.readFile(bashFilePathIn, 'utf8', function (err, data) {
 		/\$main_commands\$/g,
 		'main_commands="' + mainCommandsStr + '"',
 	);
-	let subCommands = [];
-	let prevElement = additionalCommands[0][0];
+	var subCommands = [];
+	var prevElement = additionalCommands[0][0];
 	additionalCommands.forEach(function (element) {
 		if (element[0] === prevElement) {
 			subCommands.push(element[1]);
@@ -134,8 +134,8 @@ fs.readFile(zshFilePathIn, 'utf8', function (err, data) {
 		/\$main_commands\$/g,
 		'main_commands=( ' + mainCommandsStr + ' )',
 	);
-	let subCommands = [];
-	let prevElement = additionalCommands[0][0];
+	var subCommands = [];
+	var prevElement = additionalCommands[0][0];
 	additionalCommands.forEach(function (element) {
 		if (element[0] === prevElement) {
 			subCommands.push(element[1]);

completion/templates/zsh.template

@@ -14,7 +14,7 @@ $sub_cmds$
 
   _arguments -C \
     '(- 1 *)--version[show version and exit]' \
-    '(- 1 *)--help[show help options and exit]' \
+    '(- 1 *)'{-h,--help}'[show help options and exit]' \
     '1:first command:_balena_main_cmds' \
     '2:second command:_balena_sec_cmds' \
   && ret=0

doc/automated-init.md

@@ -0,0 +1,112 @@
+# Provisioning balena devices in automated (non-interactive) mode
+
+This document describes how to run the `device init` command in non-interactive mode.
+
+It requires collecting some preliminary information _once_.
+
+The final command to provision the device looks like this:
+
+```bash
+balena device init --fleet FLEET_ID --os-version OS_VERSION --drive DRIVE --config CONFIG_FILE --yes
+
+```
+
+You can run this command as many times as you need, putting the new medium (SD card / USB stick) each time.
+
+But before you can run it you need to collect the parameters and build the configuration file. Keep reading to figure out how to do it.
+
+
+## Collect all the required parameters.
+
+1. `DEVICE_TYPE`. Run
+	```bash
+	balena devices supported
+	```
+	and find the _slug_ for your target device type, like _raspberrypi3_.
+
+1. `FLEET_ID`. Create a fleet (`balena fleet create FLEET_NAME --type DEVICE_TYPE`) or find an existing one (`balena fleets`) and notice its ID.
+
+1. `OS_VERSION`. Run
+	```bash
+	balena os versions DEVICE_TYPE
+	```
+	and pick the version that you need, like _v2.0.6+rev1.prod_.
+	_Note_ that even though we support _semver ranges_ it's recommended to use the exact version when doing the automated provisioning as it
+	guarantees full compatibility between the steps.
+
+1. `DRIVE`. Plug in your target medium (SD card or the USB stick, depending on your device type) and run
+	```bash
+	balena util available-drives
+	```
+	and get the drive name, like _/dev/sdb_ or _/dev/mmcblk0_.
+	The balena CLI will not display the system drives to protect you,
+	but still please check very carefully that you've picked the correct drive as it will be erased during the provisioning process.
+
+Now we have all the parameters -- time to build the config file.
+
+## Build the config file
+
+Interactive device provisioning process often includes collecting some extra device configuration, like the networking mode and wifi credentials.
+
+To skip this interactive step we need to buid this configuration once and save it to the JSON file for later reuse.
+
+Let's say we will place it into the `CONFIG_FILE` path, like _./balena-os/raspberrypi3-config.json_.
+
+We also need to put the OS image somewhere, let's call this path `OS_IMAGE_PATH`, it can be something like _./balena-os/raspberrypi3-v2.0.6+rev1.prod.img_.
+
+1. First we need to download the OS image once. That's needed for building the config, and will speedup the subsequent operations as the downloaded OS image is placed into the local cache.
+
+	Run:
+	```bash
+	balena os download DEVICE_TYPE --output OS_IMAGE_PATH --version OS_VERSION
+	```
+
+1. Now we're ready to build the config:
+
+	```bash
+	balena os build-config OS_IMAGE_PATH DEVICE_TYPE --output CONFIG_FILE
+	```
+
+	This will run you through the interactive configuration wizard and in the end save the generated config as `CONFIG_FILE`. You can then verify it's not empty:
+
+	```bash
+	cat CONFIG_FILE
+	```
+
+## Done
+
+Now you're ready to run the command in the beginning of this guide.
+
+Please note again that all of these steps only need to be done once (unless you need to change something), and once all the parameters are collected the main init command can be run unchanged.
+
+But there are still some nuances to cover, please read below. 
+
+## Nuances
+
+### `sudo` password on *nix systems
+
+In order to write the image to the raw device we need the root permissions, this is unavoidable.
+
+To improve the security we only run the minimal subcommand with `sudo`.
+
+This means that with the default setup you're interrupted closer to the end of the device init process to enter your sudo password for this subcommand to work.
+
+There are several ways to eliminate it and make the process fully non-interactive.
+
+#### Option 1: make passwordless sudo.
+
+Obviously you shouldn't do that if the machine you're working on has access to any sensitive resources or information.
+
+But if you're using a machine dedicated to balena provisioning this can be fine, and also the simplest thing to do.
+
+#### Option 2: `NOPASSWD` directive
+
+You can configure the `balena` CLI command to be sudo-runnable without the password. Check [this post](https://askubuntu.com/questions/159007/how-do-i-run-specific-sudo-commands-without-a-password) for an example.
+
+### Extra initialization config
+
+As of June 2017 all the supported devices should not require any other interactive configuration.
+
+But by the design of our system it is _possible_ (though it doesn't look very likely it's going to happen any time soon) that some extra initialization options may be requested for the specific device types.
+
+If that is the case please raise the issue in the balena CLI repository and the maintainers will add the necessary options to build the similar JSON config for this step.

eslint.config.js

@@ -1,32 +0,0 @@
-const { FlatCompat } = require('@eslint/eslintrc');
-
-const compat = new FlatCompat({
-	baseDirectory: __dirname,
-});
-module.exports = [
-	...require('@balena/lint/config/eslint.config'),
-	...compat.config({
-		parserOptions: {
-			project: 'tsconfig.dev.json',
-		},
-		ignorePatterns: ['**/generate-completion.js', '**/bin/**/*'],
-		rules: {
-			ignoreDefinitionFiles: 0,
-			'@typescript-eslint/no-non-null-assertion': 'off',
-			'@typescript-eslint/no-shadow': 'off',
-			'@typescript-eslint/no-var-requires': 'off',
-			'@typescript-eslint/no-require-imports': 'off',
-			'@typescript-eslint/no-unnecessary-type-assertion': 'off',
-			'@typescript-eslint/prefer-nullish-coalescing': 'warn',
-
-			'no-restricted-imports': ['error', {
-				paths: ['resin-cli-visuals', 'chalk', 'common-tags', 'resin-cli-form'],
-			}],
-
-			'@typescript-eslint/no-unused-vars': ['error', {
-				argsIgnorePattern: '^_',
-				caughtErrorsIgnorePattern: '^_',
-			}],
-		},
-	}),
-];

gulpfile.js

@@ -0,0 +1,15 @@
+const gulp = require('gulp');
+const inlinesource = require('gulp-inline-source');
+
+const OPTIONS = {
+	files: {
+		pages: 'lib/auth/pages/*.ejs',
+	},
+};
+
+gulp.task('pages', () =>
+	gulp
+		.src(OPTIONS.files.pages)
+		.pipe(inlinesource())
+		.pipe(gulp.dest('build/auth/pages')),
+);

lib/app.ts

@@ -16,15 +16,14 @@
  */
 
 import * as packageJSON from '../package.json';
-import type { AppOptions } from './preparser';
 import {
+	AppOptions,
 	checkDeletedCommand,
 	preparseArgs,
 	unsupportedFlag,
 } from './preparser';
 import { CliSettings } from './utils/bootstrap';
 import { onceAsync } from './utils/lazy';
-import { run as mainRun, settings } from '@oclif/core';
 
 /**
  * Sentry.io setup
@@ -34,14 +33,18 @@ export const setupSentry = onceAsync(async () => {
 	const config = await import('./config');
 	const Sentry = await import('@sentry/node');
 	Sentry.init({
+		autoSessionTracking: false,
 		dsn: config.sentryDsn,
 		release: packageJSON.version,
 	});
-	Sentry.getCurrentScope().setExtras({
-		is_pkg: !!(process as any).pkg,
-		node_version: process.version,
-		platform: process.platform,
+	Sentry.configureScope((scope) => {
+		scope.setExtras({
+			is_pkg: !!(process as any).pkg,
+			node_version: process.version,
+			platform: process.platform,
+		});
 	});
+	return Sentry.getCurrentHub();
 });
 
 async function checkNodeVersion() {
@@ -74,13 +77,11 @@ export function setMaxListeners(maxListeners: number) {
 /** Selected CLI initialization steps */
 async function init() {
 	if (process.env.BALENARC_NO_SENTRY) {
-		if (process.env.DEBUG) {
-			console.error(`WARN: disabling Sentry.io error reporting`);
-		}
+		console.error(`WARN: disabling Sentry.io error reporting`);
 	} else {
 		await setupSentry();
 	}
-	await checkNodeVersion();
+	checkNodeVersion();
 
 	const settings = new CliSettings();
 
@@ -90,16 +91,16 @@ async function init() {
 	setupBalenaSdkSharedOptions(settings);
 
 	// check for CLI updates once a day
-	if (!process.env.BALENARC_OFFLINE_MODE) {
-		(await import('./utils/update')).notify();
-	}
+	(await import('./utils/update')).notify();
 }
 
 /** Execute the oclif parser and the CLI command. */
 async function oclifRun(command: string[], options: AppOptions) {
-	let deprecationPromise: Promise<void> | undefined;
+	let deprecationPromise: Promise<void>;
 	// check and enforce the CLI's deprecation policy
-	if (!(unsupportedFlag || process.env.BALENARC_UNSUPPORTED)) {
+	if (unsupportedFlag || process.env.BALENARC_UNSUPPORTED) {
+		deprecationPromise = Promise.resolve();
+	} else {
 		const { DeprecationChecker } = await import('./deprecation');
 		const deprecationChecker = new DeprecationChecker(packageJSON.version);
 		// warnAndAbortIfDeprecated uses previously cached data only
@@ -109,16 +110,10 @@ async function oclifRun(command: string[], options: AppOptions) {
 	}
 
 	const runPromise = (async function (shouldFlush: boolean) {
+		const { CustomMain } = await import('./utils/oclif-utils');
 		let isEEXIT = false;
 		try {
-			if (options.development) {
-				// In dev mode -> use ts-node and dev plugins
-				process.env.NODE_ENV = 'development';
-				settings.debug = true;
-			}
-			// For posteriority: We can't use default oclif 'execute' as
-			// We customize error handling and flushing
-			await mainRun(command, options.loadOptions ?? options.dir);
+			await CustomMain.run(command);
 		} catch (error) {
 			// oclif sometimes exits with ExitError code EEXIT 0 (not an error),
 			// for example the `balena help` command.
@@ -131,8 +126,7 @@ async function oclifRun(command: string[], options: AppOptions) {
 			}
 		}
 		if (shouldFlush) {
-			const { flush } = await import('@oclif/core');
-			await flush();
+			await import('@oclif/command/flush');
 		}
 		// TODO: figure out why we need to call fast-boot stop() here, in
 		// addition to calling it in the main `run()` function in this file.
@@ -147,20 +141,23 @@ async function oclifRun(command: string[], options: AppOptions) {
 		}
 	})(!options.noFlush);
 
-	const { trackPromise } = await import('./hooks/prerun');
+	const { trackPromise } = await import('./hooks/prerun/track');
 
 	await Promise.all([trackPromise, deprecationPromise, runPromise]);
 }
 
-/** CLI entrypoint. Called by the `bin/run.js` and `bin/dev.js` scripts. */
-export async function run(cliArgs = process.argv, options: AppOptions) {
+/** 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 } = await import(
-			'./utils/bootstrap'
-		);
-		setOfflineModeEnvVars();
+		const { normalizeEnvVars, pkgExec } = await import('./utils/bootstrap');
 		normalizeEnvVars();
 
+		// The 'pkgExec' special/internal command provides a Node.js interpreter
+		// for use of the standalone zip package. See pkgExec function.
+		if (cliArgs.length > 3 && cliArgs[2] === 'pkgExec') {
+			return pkgExec(cliArgs[3], cliArgs.slice(4));
+		}
+
 		await init();
 
 		// Look for commands that have been removed and if so, exit with a notice

lib/auth/index.ts

@@ -56,7 +56,7 @@ export async function login({ host = '127.0.0.1', port = 0 }) {
 
 	console.info(`Opening web browser for URL:\n${loginUrl}`);
 	const open = await import('open');
-	await open(loginUrl, { wait: false });
+	open(loginUrl, { wait: false });
 
 	const balena = getBalenaSdk();
 	const token = await loginServer.awaitForToken();

lib/auth/utils.ts

@@ -14,44 +14,57 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+import * as _ from 'lodash';
+import * as url from 'url';
 import { getBalenaSdk } from '../utils/lazy';
 
 /**
- * Get dashboard CLI login URL
+ * @summary Get dashboard CLI login URL
+ * @function
+ * @protected
  *
- * @param callbackUrl - Callback url, e.g. 'http://127.0.0.1:3000'
- * @returns Dashboard login URL, e.g.:
- * 'https://dashboard.balena-cloud.com/login/cli/http%253A%252F%252F127.0.0.1%253A59581%252Fauth'
+ * @param {String} callbackUrl - callback url
+ * @fulfil {String} - dashboard login url
+ * @returns {Promise}
+ *
+ * @example
+ * utils.getDashboardLoginURL('http://127.0.0.1:3000').then (url) ->
+ * 	console.log(url)
  */
-export async function getDashboardLoginURL(
-	callbackUrl: string,
-): Promise<string> {
+export const getDashboardLoginURL = (callbackUrl: string) => {
 	// Encode percentages signs from the escaped url
 	// characters to avoid angular getting confused.
 	callbackUrl = encodeURIComponent(callbackUrl).replace(/%/g, '%25');
 
-	const [{ URL }, dashboardUrl] = await Promise.all([
-		import('url'),
-		getBalenaSdk().settings.get('dashboardUrl'),
-	]);
-	return new URL(`/login/cli/${callbackUrl}`, dashboardUrl).href;
-}
+	return getBalenaSdk()
+		.settings.get('dashboardUrl')
+		.then((dashboardUrl) =>
+			url.resolve(dashboardUrl, `/login/cli/${callbackUrl}`),
+		);
+};
 
 /**
- * Log in using a token, but only if the token is valid.
+ * @summary Log in using a token, but only if the token is valid
+ * @function
+ * @protected
  *
+ * @description
  * This function checks that the token is not only well-structured
  * but that it also authenticates with the server successfully.
  *
  * If authenticated, the token is persisted, if not then the previous
  * login state is restored.
  *
- * @param token - session token or api key
- * @returns whether the login was successful or not
+ * @param {String} token - session token or api key
+ * @fulfil {Boolean} - whether the login was successful or not
+ * @returns {Promise}
+ *
+ * utils.loginIfTokenValid('...').then (loggedIn) ->
+ *   if loggedIn
+ *     console.log('Token is valid!')
  */
-export async function loginIfTokenValid(token?: string): Promise<boolean> {
-	token = (token || '').trim();
-	if (!token) {
+export const loginIfTokenValid = async (token: string): Promise<boolean> => {
+	if (_.isEmpty(token?.trim())) {
 		return false;
 	}
 	const balena = getBalenaSdk();
@@ -73,4 +86,4 @@ export async function loginIfTokenValid(token?: string): Promise<boolean> {
 		}
 	}
 	return isLoggedIn;
-}
+};

lib/command.ts

@@ -0,0 +1,132 @@
+/**
+ * @license
+ * Copyright 2020 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import Command from '@oclif/command';
+import { InsufficientPrivilegesError } from './errors';
+
+export default abstract class BalenaCommand extends Command {
+	/**
+	 * When set to true, command will be listed in `help`,
+	 * otherwise listed in `help --verbose` with secondary commands.
+	 */
+	public static primary = false;
+
+	/**
+	 * Require elevated privileges to run.
+	 * When set to true, command will exit with an error
+	 * if executed without root on Mac/Linux
+	 * or if executed by non-Administrator on Windows.
+	 */
+	public static root = false;
+
+	/**
+	 * Require authentication to run.
+	 * When set to true, command will exit with an error
+	 * if user is not already logged in.
+	 */
+	public static authenticated = false;
+
+	/**
+	 * Accept piped input.
+	 * When set to true, command will read from stdin during init
+	 * and make contents available on member `stdin`.
+	 */
+	public static readStdin = false;
+
+	public stdin: string;
+
+	/**
+	 * Throw InsufficientPrivilegesError if not root on Mac/Linux
+	 * or non-Administrator on Windows.
+	 *
+	 * Called automatically if `root=true`.
+	 * Can be called explicitly by command implementation, if e.g.:
+	 *  - check should only be done conditionally
+	 *  - other code needs to execute before check
+	 */
+	protected static async checkElevatedPrivileges() {
+		const isElevated = await (await import('is-elevated'))();
+		if (!isElevated) {
+			throw new InsufficientPrivilegesError(
+				'You need root/admin privileges to run this command',
+			);
+		}
+	}
+
+	/**
+	 * Throw NotLoggedInError if not logged in.
+	 *
+	 * Called automatically if `authenticated=true`.
+	 * Can be called explicitly by command implementation, if e.g.:
+	 *  - check should only be done conditionally
+	 *  - other code needs to execute before check
+	 *
+	 *  Note, currently public to allow use outside of derived commands
+	 *  (as some command implementations require this. Can be made protected
+	 *  if this changes).
+	 *
+	 * @throws {NotLoggedInError}
+	 */
+	public static async checkLoggedIn() {
+		await (await import('./utils/patterns')).checkLoggedIn();
+	}
+
+	/**
+	 * Throw NotLoggedInError if not logged in when condition true.
+	 *
+	 * @param {boolean} doCheck - will check if true.
+	 * @throws {NotLoggedInError}
+	 */
+	public static async checkLoggedInIf(doCheck: boolean) {
+		if (doCheck) {
+			await this.checkLoggedIn();
+		}
+	}
+
+	/**
+	 * Read stdin contents and make available to command.
+	 *
+	 * This approach could be improved in the future to automatically set argument
+	 * values from stdin based in configuration, minimising command implementation.
+	 */
+	protected async getStdin() {
+		this.stdin = await (await import('get-stdin'))();
+	}
+
+	/**
+	 * Get a logger instance.
+	 */
+	protected static async getLogger() {
+		return (await import('./utils/logger')).getLogger();
+	}
+
+	protected async init() {
+		const ctr = this.constructor as typeof BalenaCommand;
+
+		if (ctr.root) {
+			await BalenaCommand.checkElevatedPrivileges();
+		}
+
+		if (ctr.authenticated) {
+			await BalenaCommand.checkLoggedIn();
+		}
+
+		if (ctr.readStdin) {
+			await this.getStdin();
+		}
+	}
+}

lib/commands/api-key/generate.ts

@@ -0,0 +1,85 @@
+/**
+ * @license
+ * Copyright 2016-2020 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { flags } from '@oclif/command';
+import Command from '../../command';
+import { ExpectedError } from '../../errors';
+import * as cf from '../../utils/common-flags';
+import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	name: string;
+}
+
+export default class GenerateCmd extends Command {
+	public static description = stripIndent`
+		Generate a new balenaCloud API key.
+
+		Generate a new balenaCloud API key for the current user, with the given
+		name. The key will be logged to the console.
+
+		This key can be used to log into the CLI using 'balena login --token <key>',
+		or to authenticate requests to the API with an 'Authorization: Bearer <key>' header.
+`;
+	public static examples = ['$ balena api-key generate "Jenkins Key"'];
+
+	public static args = [
+		{
+			name: 'name',
+			description: 'the API key name',
+			required: true,
+		},
+	];
+
+	public static usage = 'api-key generate <name>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+
+	public async run() {
+		const { args: params } = this.parse<FlagsDef, ArgsDef>(GenerateCmd);
+
+		let key;
+		try {
+			key = await getBalenaSdk().models.apiKey.create(params.name);
+		} catch (e) {
+			if (e.name === 'BalenaNotLoggedIn') {
+				throw new ExpectedError(stripIndent`
+					This command cannot be run when logged in with an API key.
+					Please login again with 'balena login' and select an alternative method.
+				`);
+			} else {
+				throw e;
+			}
+		}
+
+		console.log(stripIndent`
+			Registered api key '${params.name}':
+
+			${key}
+
+			This key will not be shown again, so please save it now.
+		`);
+	}
+}

lib/commands/app/create.ts

@@ -0,0 +1,181 @@
+/**
+ * @license
+ * Copyright 2016-2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { flags } from '@oclif/command';
+import type { Output as ParserOutput } from '@oclif/parser';
+import type { Application } from 'balena-sdk';
+
+import Command from '../../command';
+import { ExpectedError } from '../../errors';
+import * as cf from '../../utils/common-flags';
+import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import { appToFleetCmdMsg, warnify } from '../../utils/messages';
+
+interface FlagsDef {
+	organization?: string;
+	type?: string; // application device type
+	help: void;
+}
+
+interface ArgsDef {
+	name: string;
+}
+
+export class FleetCreateCmd extends Command {
+	public static description = stripIndent`
+		Create a fleet.
+
+		Create a new balena fleet.
+
+		You can specify the organization the fleet should belong to using
+		the \`--organization\` option. The organization's handle, not its name,
+		should be provided. Organization handles can be listed with the
+		\`balena orgs\` command.
+
+		The fleet's default device type is specified with the \`--type\` option.
+		The \`balena devices supported\` command can be used to list the available
+		device types.
+
+		Interactive dropdowns will be shown for selection if no device type or
+		organization is specified and there are multiple options to choose from.
+		If there is a single option to choose from, it will be chosen automatically.
+		This interactive behavior can be disabled by explicitly specifying a device
+		type and organization.
+	`;
+
+	public static examples = [
+		'$ balena fleet create MyFleet',
+		'$ balena fleet create MyFleet --organization mmyorg',
+		'$ balena fleet create MyFleet -o myorg --type raspberry-pi',
+	];
+
+	public static args = [
+		{
+			name: 'name',
+			description: 'fleet name',
+			required: true,
+		},
+	];
+
+	public static usage = 'fleet create <name>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		organization: flags.string({
+			char: 'o',
+			description: 'handle of the organization the fleet should belong to',
+		}),
+		type: flags.string({
+			char: 't',
+			description:
+				'fleet device type (Check available types with `balena devices supported`)',
+		}),
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+
+	public async run(parserOutput?: ParserOutput<FlagsDef, ArgsDef>) {
+		const { args: params, flags: options } =
+			parserOutput || this.parse<FlagsDef, ArgsDef>(FleetCreateCmd);
+
+		// Ascertain device type
+		const deviceType =
+			options.type ||
+			(await (await import('../../utils/patterns')).selectDeviceType());
+
+		// Ascertain organization
+		const organization =
+			options.organization?.toLowerCase() || (await this.getOrganization());
+
+		// Create application
+		let application: Application;
+		try {
+			application = await getBalenaSdk().models.application.create({
+				name: params.name,
+				deviceType,
+				organization,
+			});
+		} catch (err) {
+			if ((err.message || '').toLowerCase().includes('unique')) {
+				// BalenaRequestError: Request error: "organization" and "app_name" must be unique.
+				throw new ExpectedError(
+					`Error: fleet "${params.name}" already exists in organization "${organization}".`,
+				);
+			} else if ((err.message || '').toLowerCase().includes('unauthorized')) {
+				// BalenaRequestError: Request error: Unauthorized
+				throw new ExpectedError(
+					`Error: You are not authorized to create fleets in organization "${organization}".`,
+				);
+			}
+
+			throw err;
+		}
+
+		// Output
+		const { isV13 } = await import('../../utils/version');
+		console.log(
+			isV13()
+				? `Fleet created: slug "${application.slug}", device type "${deviceType}"`
+				: `Fleet created: ${application.slug} (${deviceType}, id ${application.id})`,
+		);
+	}
+
+	async getOrganization() {
+		const { getOwnOrganizations } = await import('../../utils/sdk');
+		const organizations = await getOwnOrganizations(getBalenaSdk());
+
+		if (organizations.length === 0) {
+			// User is not a member of any organizations (should not happen).
+			throw new Error('This account is not a member of any organizations');
+		} else if (organizations.length === 1) {
+			// User is a member of only one organization - use this.
+			return organizations[0].handle;
+		} else {
+			// User is a member of multiple organizations -
+			const { selectOrganization } = await import('../../utils/patterns');
+			return selectOrganization(organizations);
+		}
+	}
+}
+
+export default class AppCreateCmd extends FleetCreateCmd {
+	public static description = stripIndent`
+		DEPRECATED alias for the 'fleet create' command
+
+		${appToFleetCmdMsg
+			.split('\n')
+			.map((l) => `\t\t${l}`)
+			.join('\n')}
+
+		For command usage, see 'balena help fleet create'
+	`;
+	public static examples = [];
+	public static usage = 'app create <name>';
+	public static args = FleetCreateCmd.args;
+	public static flags = FleetCreateCmd.flags;
+	public static authenticated = FleetCreateCmd.authenticated;
+	public static primary = FleetCreateCmd.primary;
+
+	public async run() {
+		// call this.parse() before deprecation message to parse '-h'
+		const parserOutput = this.parse<FlagsDef, ArgsDef>(AppCreateCmd);
+		if (process.stderr.isTTY) {
+			console.error(warnify(appToFleetCmdMsg));
+		}
+		await super.run(parserOutput);
+	}
+}

lib/commands/app/index.ts

@@ -0,0 +1,124 @@
+/**
+ * @license
+ * Copyright 2016-2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { flags } from '@oclif/command';
+import type { Output as ParserOutput } from '@oclif/parser';
+import type { Release } from 'balena-sdk';
+
+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 {
+	applicationIdInfo,
+	appToFleetCmdMsg,
+	warnify,
+} from '../../utils/messages';
+
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+}
+
+export class FleetCmd extends Command {
+	public static description = stripIndent`
+		Display information about a single fleet.
+
+		Display detailed information about a single fleet.
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+`;
+	public static examples = [
+		'$ balena fleet MyFleet',
+		'$ balena fleet myorg/myfleet',
+	];
+
+	public static args = [ca.fleetRequired];
+
+	public static usage = 'fleet <fleet>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+	public static primary = true;
+
+	public async run(parserOutput?: ParserOutput<FlagsDef, ArgsDef>) {
+		const { args: params } =
+			parserOutput || this.parse<FlagsDef, ArgsDef>(FleetCmd);
+
+		const { getApplication } = await import('../../utils/sdk');
+
+		const application = (await getApplication(getBalenaSdk(), params.fleet, {
+			$expand: {
+				is_for__device_type: { $select: 'slug' },
+				should_be_running__release: { $select: 'commit' },
+			},
+		})) as ApplicationWithDeviceType & {
+			should_be_running__release: [Release?];
+			// For display purposes:
+			device_type: string;
+			commit?: string;
+		};
+
+		application.device_type = application.is_for__device_type[0].slug;
+		application.commit = application.should_be_running__release[0]?.commit;
+
+		// Emulate table.vertical title output, but avoid uppercasing and inserting spaces
+		console.log(`== ${application.app_name}`);
+		console.log(
+			getVisuals().table.vertical(application, [
+				'id',
+				'device_type',
+				'slug',
+				'commit',
+			]),
+		);
+	}
+}
+
+export default class AppCmd extends FleetCmd {
+	public static description = stripIndent`
+		DEPRECATED alias for the 'fleet' command
+
+		${appToFleetCmdMsg
+			.split('\n')
+			.map((l) => `\t\t${l}`)
+			.join('\n')}
+
+		For command usage, see 'balena help fleet'
+	`;
+	public static examples = [];
+	public static usage = 'app <fleet>';
+	public static args = FleetCmd.args;
+	public static flags = FleetCmd.flags;
+	public static authenticated = FleetCmd.authenticated;
+	public static primary = FleetCmd.primary;
+
+	public async run() {
+		// call this.parse() before deprecation message to parse '-h'
+		const parserOutput = this.parse<FlagsDef, ArgsDef>(AppCmd);
+		if (process.stderr.isTTY) {
+			console.error(warnify(appToFleetCmdMsg));
+		}
+		await super.run(parserOutput);
+	}
+}

lib/commands/app/purge.ts

@@ -15,12 +15,28 @@
  * limitations under the License.
  */
 
-import { Command } from '@oclif/core';
+import type { flags } from '@oclif/command';
+import type { Output as ParserOutput } from '@oclif/parser';
+
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
 import * as ca from '../../utils/common-args';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
-import { applicationIdInfo } from '../../utils/messages';
+import {
+	applicationIdInfo,
+	appToFleetCmdMsg,
+	warnify,
+} from '../../utils/messages';
 
-export default class FleetPurgeCmd extends Command {
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+}
+
+export class FleetPurgeCmd extends Command {
 	public static description = stripIndent`
 		Purge data from a fleet.
 
@@ -35,14 +51,19 @@ export default class FleetPurgeCmd extends Command {
 		'$ balena fleet purge myorg/myfleet',
 	];
 
-	public static args = {
-		fleet: ca.fleetRequired,
+	public static args = [ca.fleetRequired];
+
+	public static usage = 'fleet purge <fleet>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
-	public async run() {
-		const { args: params } = await this.parse(FleetPurgeCmd);
+	public async run(parserOutput?: ParserOutput<FlagsDef, ArgsDef>) {
+		const { args: params } =
+			parserOutput || this.parse<FlagsDef, ArgsDef>(FleetPurgeCmd);
 
 		const { getApplication } = await import('../../utils/sdk');
 
@@ -50,9 +71,7 @@ export default class FleetPurgeCmd extends Command {
 
 		// balena.models.application.purge only accepts a numeric id
 		// so we must first fetch the app to get it's id,
-		const application = await getApplication(balena, params.fleet, {
-			$select: 'id',
-		});
+		const application = await getApplication(balena, params.fleet);
 
 		try {
 			await balena.models.application.purge(application.id);
@@ -66,3 +85,31 @@ export default class FleetPurgeCmd extends Command {
 		}
 	}
 }
+
+export default class AppPurgeCmd extends FleetPurgeCmd {
+	public static description = stripIndent`
+		DEPRECATED alias for the 'fleet purge' command
+
+		${appToFleetCmdMsg
+			.split('\n')
+			.map((l) => `\t\t${l}`)
+			.join('\n')}
+
+		For command usage, see 'balena help fleet purge'
+	`;
+	public static examples = [];
+	public static usage = 'app purge <fleet>';
+	public static args = FleetPurgeCmd.args;
+	public static flags = FleetPurgeCmd.flags;
+	public static authenticated = FleetPurgeCmd.authenticated;
+	public static primary = FleetPurgeCmd.primary;
+
+	public async run() {
+		// call this.parse() before deprecation message to parse '-h'
+		const parserOutput = this.parse<FlagsDef, ArgsDef>(AppPurgeCmd);
+		if (process.stderr.isTTY) {
+			console.error(warnify(appToFleetCmdMsg));
+		}
+		await super.run(parserOutput);
+	}
+}

lib/commands/app/rename.ts

@@ -15,12 +15,30 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import type { flags } from '@oclif/command';
+import type { Output as ParserOutput } from '@oclif/parser';
+import type { ApplicationType } from 'balena-sdk';
+
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
 import * as ca from '../../utils/common-args';
 import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy';
-import { applicationIdInfo } from '../../utils/messages';
+import {
+	applicationIdInfo,
+	appToFleetCmdMsg,
+	warnify,
+} from '../../utils/messages';
 
-export default class FleetRenameCmd extends Command {
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+	newName?: string;
+}
+
+export class FleetRenameCmd extends Command {
 	public static description = stripIndent`
 		Rename a fleet.
 
@@ -38,17 +56,25 @@ export default class FleetRenameCmd extends Command {
 		'$ balena fleet rename myorg/oldname NewName',
 	];
 
-	public static args = {
-		fleet: ca.fleetRequired,
-		newName: Args.string({
+	public static args = [
+		ca.fleetRequired,
+		{
+			name: 'newName',
 			description: 'the new name for the fleet',
-		}),
+		},
+	];
+
+	public static usage = 'fleet rename <fleet> [newName]';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
-	public async run() {
-		const { args: params } = await this.parse(FleetRenameCmd);
+	public async run(parserOutput?: ParserOutput<FlagsDef, ArgsDef>) {
+		const { args: params } =
+			parserOutput || this.parse<FlagsDef, ArgsDef>(FleetRenameCmd);
 
 		const { validateApplicationName } = await import('../../utils/validation');
 		const { ExpectedError } = await import('../../errors');
@@ -58,10 +84,9 @@ export default class FleetRenameCmd extends Command {
 		// Disambiguate target application (if params.params is a number, it could either be an ID or a numerical name)
 		const { getApplication } = await import('../../utils/sdk');
 		const application = await getApplication(balena, params.fleet, {
-			$select: ['id', 'app_name', 'slug'],
 			$expand: {
 				application_type: {
-					$select: 'slug',
+					$select: ['is_legacy'],
 				},
 			},
 		});
@@ -72,8 +97,8 @@ export default class FleetRenameCmd extends Command {
 		}
 
 		// Check app supports renaming
-		const appType = application.application_type[0];
-		if (appType.slug === 'legacy-v1' || appType.slug === 'legacy-v2') {
+		const appType = (application.application_type as ApplicationType[])?.[0];
+		if (appType.is_legacy) {
 			throw new ExpectedError(
 				`Fleet ${params.fleet} is of 'legacy' type, and cannot be renamed.`,
 			);
@@ -89,34 +114,21 @@ export default class FleetRenameCmd extends Command {
 			})) ||
 			'';
 
-		// Check they haven't used slug in new name
-		if (newName.includes('/')) {
-			throw new ExpectedError(
-				`New fleet name cannot include '/', please check that you are not specifying fleet slug.`,
-			);
-		}
-
 		// Rename
 		try {
 			await balena.models.application.rename(application.id, newName);
 		} catch (e) {
 			// BalenaRequestError: Request error: "organization" and "app_name" must be unique.
 			if ((e.message || '').toLowerCase().includes('unique')) {
-				throw new ExpectedError(`Error: fleet ${newName} already exists.`);
-			}
-			// BalenaRequestError: Request error: App name may only contain [a-zA-Z0-9_-].
-			if ((e.message || '').toLowerCase().includes('name may only contain')) {
-				throw new ExpectedError(
-					`Error: new fleet name may only include characters [a-zA-Z0-9_-].`,
-				);
+				throw new ExpectedError(`Error: fleet ${params.fleet} already exists.`);
 			}
 			throw e;
 		}
 
 		// Get application again, to be sure of results
-		const renamedApplication = await getApplication(balena, application.id, {
-			$select: ['app_name', 'slug'],
-		});
+		const renamedApplication = await balena.models.application.get(
+			application.id,
+		);
 
 		// Output result
 		console.log(`Fleet renamed`);
@@ -128,3 +140,31 @@ export default class FleetRenameCmd extends Command {
 		console.log(`\tslug: ${renamedApplication.slug}`);
 	}
 }
+
+export default class AppRenameCmd extends FleetRenameCmd {
+	public static description = stripIndent`
+		DEPRECATED alias for the 'fleet rename' command
+
+		${appToFleetCmdMsg
+			.split('\n')
+			.map((l) => `\t\t${l}`)
+			.join('\n')}
+
+		For command usage, see 'balena help fleet rename'
+	`;
+	public static examples = [];
+	public static usage = 'app rename <fleet> [newName]';
+	public static args = FleetRenameCmd.args;
+	public static flags = FleetRenameCmd.flags;
+	public static authenticated = FleetRenameCmd.authenticated;
+	public static primary = FleetRenameCmd.primary;
+
+	public async run() {
+		// call this.parse() before deprecation message to parse '-h'
+		const parserOutput = this.parse<FlagsDef, ArgsDef>(AppRenameCmd);
+		if (process.stderr.isTTY) {
+			console.error(warnify(appToFleetCmdMsg));
+		}
+		await super.run(parserOutput);
+	}
+}

lib/commands/app/restart.ts

@@ -0,0 +1,104 @@
+/**
+ * @license
+ * Copyright 2016-2020 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { flags } from '@oclif/command';
+import type { Output as ParserOutput } from '@oclif/parser';
+
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
+import * as ca from '../../utils/common-args';
+import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import {
+	applicationIdInfo,
+	appToFleetCmdMsg,
+	warnify,
+} from '../../utils/messages';
+
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+}
+
+export class FleetRestartCmd extends Command {
+	public static description = stripIndent`
+		Restart a fleet.
+
+		Restart all devices belonging to a fleet.
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+	`;
+
+	public static examples = [
+		'$ balena fleet restart MyFleet',
+		'$ balena fleet restart myorg/myfleet',
+	];
+
+	public static args = [ca.fleetRequired];
+
+	public static usage = 'fleet restart <fleet>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+
+	public async run(parserOutput?: ParserOutput<FlagsDef, ArgsDef>) {
+		const { args: params } =
+			parserOutput || this.parse<FlagsDef, ArgsDef>(FleetRestartCmd);
+
+		const { getApplication } = await import('../../utils/sdk');
+
+		const balena = getBalenaSdk();
+
+		// Disambiguate application (if is a number, it could either be an ID or a numerical name)
+		const application = await getApplication(balena, params.fleet);
+
+		await balena.models.application.restart(application.id);
+	}
+}
+
+export default class AppRestartCmd extends FleetRestartCmd {
+	public static description = stripIndent`
+		DEPRECATED alias for the 'fleet restart' command
+
+		${appToFleetCmdMsg
+			.split('\n')
+			.map((l) => `\t\t${l}`)
+			.join('\n')}
+
+		For command usage, see 'balena help fleet restart'
+	`;
+	public static examples = [];
+	public static usage = 'app restart <fleet>';
+	public static args = FleetRestartCmd.args;
+	public static flags = FleetRestartCmd.flags;
+	public static authenticated = FleetRestartCmd.authenticated;
+	public static primary = FleetRestartCmd.primary;
+
+	public async run() {
+		// call this.parse() before deprecation message to parse '-h'
+		const parserOutput = this.parse<FlagsDef, ArgsDef>(AppRestartCmd);
+		if (process.stderr.isTTY) {
+			console.error(warnify(appToFleetCmdMsg));
+		}
+		await super.run(parserOutput);
+	}
+}

lib/commands/app/rm.ts

@@ -15,13 +15,29 @@
  * limitations under the License.
  */
 
+import type { flags } from '@oclif/command';
+import type { Output as ParserOutput } from '@oclif/parser';
+
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import * as ca from '../../utils/common-args';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
-import { applicationIdInfo } from '../../utils/messages';
-import { Command } from '@oclif/core';
+import {
+	applicationIdInfo,
+	appToFleetCmdMsg,
+	warnify,
+} from '../../utils/messages';
 
-export default class FleetRmCmd extends Command {
+interface FlagsDef {
+	yes: boolean;
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+}
+
+export class FleetRmCmd extends Command {
 	public static description = stripIndent`
 		Remove a fleet.
 
@@ -38,18 +54,20 @@ export default class FleetRmCmd extends Command {
 		'$ balena fleet rm myorg/myfleet',
 	];
 
-	public static args = {
-		fleet: ca.fleetRequired,
-	};
+	public static args = [ca.fleetRequired];
 
-	public static flags = {
+	public static usage = 'fleet rm <fleet>';
+
+	public static flags: flags.Input<FlagsDef> = {
 		yes: cf.yes,
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
-	public async run() {
-		const { args: params, flags: options } = await this.parse(FleetRmCmd);
+	public async run(parserOutput?: ParserOutput<FlagsDef, ArgsDef>) {
+		const { args: params, flags: options } =
+			parserOutput || this.parse<FlagsDef, ArgsDef>(FleetRmCmd);
 
 		const { confirm } = await import('../../utils/patterns');
 		const { getApplication } = await import('../../utils/sdk');
@@ -62,11 +80,37 @@ export default class FleetRmCmd extends Command {
 		);
 
 		// Disambiguate application (if is a number, it could either be an ID or a numerical name)
-		const application = await getApplication(balena, params.fleet, {
-			$select: 'slug',
-		});
+		const application = await getApplication(balena, params.fleet);
 
 		// Remove
-		await balena.models.application.remove(application.slug);
+		await balena.models.application.remove(application.id);
+	}
+}
+
+export default class AppRmCmd extends FleetRmCmd {
+	public static description = stripIndent`
+		DEPRECATED alias for the 'fleet rm' command
+
+		${appToFleetCmdMsg
+			.split('\n')
+			.map((l) => `\t\t${l}`)
+			.join('\n')}
+
+		For command usage, see 'balena help fleet rm'
+	`;
+	public static examples = [];
+	public static usage = 'app rm <fleet>';
+	public static args = FleetRmCmd.args;
+	public static flags = FleetRmCmd.flags;
+	public static authenticated = FleetRmCmd.authenticated;
+	public static primary = FleetRmCmd.primary;
+
+	public async run() {
+		// call this.parse() before deprecation message to parse '-h'
+		const parserOutput = this.parse<FlagsDef, ArgsDef>(AppRmCmd);
+		if (process.stderr.isTTY) {
+			console.error(warnify(appToFleetCmdMsg));
+		}
+		await super.run(parserOutput);
 	}
 }

lib/commands/apps.ts

@@ -0,0 +1,134 @@
+/**
+ * @license
+ * Copyright 2016-2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { flags } from '@oclif/command';
+import type { Output as ParserOutput } from '@oclif/parser';
+
+import Command from '../command';
+import * as cf from '../utils/common-flags';
+import { getBalenaSdk, getVisuals, stripIndent } from '../utils/lazy';
+import { appToFleetCmdMsg, warnify } from '../utils/messages';
+
+interface ExtendedApplication extends ApplicationWithDeviceType {
+	device_count?: number;
+	online_devices?: number;
+}
+
+interface FlagsDef {
+	help: void;
+	verbose?: boolean;
+}
+
+export class FleetsCmd extends Command {
+	public static description = stripIndent`
+		List all fleets.
+
+		List all your balena fleets.
+
+		For detailed information on a particular fleet, use
+		\`balena fleet <fleet>\`
+	`;
+
+	public static examples = ['$ balena fleets'];
+
+	public static usage = 'fleets';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
+		verbose: flags.boolean({
+			default: false,
+			char: 'v',
+			description: 'No-op since release v12.0.0',
+		}),
+	};
+
+	public static authenticated = true;
+	public static primary = true;
+
+	protected useAppWord = false;
+
+	public async run(_parserOutput?: ParserOutput<FlagsDef, {}>) {
+		_parserOutput ||= this.parse<FlagsDef, {}>(FleetsCmd);
+
+		const balena = getBalenaSdk();
+
+		// Get applications
+		const applications = (await balena.models.application.getAll({
+			$select: ['id', 'app_name', 'slug'],
+			$expand: {
+				is_for__device_type: { $select: 'slug' },
+				owns__device: { $select: 'is_online' },
+			},
+		})) as ExtendedApplication[];
+
+		const _ = await import('lodash');
+		// Add extended properties
+		applications.forEach((application) => {
+			application.device_count = application.owns__device?.length ?? 0;
+			application.online_devices = _.sumBy(application.owns__device, (d) =>
+				d.is_online === true ? 1 : 0,
+			);
+			// @ts-expect-error
+			application.device_type = application.is_for__device_type[0].slug;
+		});
+
+		// Display
+		console.log(
+			getVisuals().table.horizontal(applications, [
+				'id',
+				this.useAppWord ? 'app_name' : 'app_name => NAME',
+				'slug',
+				'device_type',
+				'online_devices',
+				'device_count',
+			]),
+		);
+	}
+}
+
+const appsToFleetsRenameMsg = appToFleetCmdMsg
+	.replace(/'app'/g, "'apps'")
+	.replace(/'fleet'/g, "'fleets'");
+
+export default class AppsCmd extends FleetsCmd {
+	public static description = stripIndent`
+		DEPRECATED alias for the 'fleets' command
+
+		${appsToFleetsRenameMsg
+			.split('\n')
+			.map((l) => `\t\t${l}`)
+			.join('\n')}
+
+		For command usage, see 'balena help fleets'
+	`;
+	public static examples = [];
+	public static usage = 'apps';
+	public static args = FleetsCmd.args;
+	public static flags = FleetsCmd.flags;
+	public static authenticated = FleetsCmd.authenticated;
+	public static primary = FleetsCmd.primary;
+
+	public async run() {
+		// call this.parse() before deprecation message to parse '-h'
+		const parserOutput = this.parse<FlagsDef, {}>(AppsCmd);
+		if (process.stderr.isTTY) {
+			console.error(warnify(appsToFleetsRenameMsg));
+		}
+		this.useAppWord = true;
+		await super.run(parserOutput);
+	}
+}

lib/commands/build.ts

@@ -15,36 +15,35 @@
  * limitations under the License.
  */
 
-import { Args, Flags, Command } from '@oclif/core';
-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 { flags } from '@oclif/command';
+import Command from '../command';
+import { getBalenaSdk } from '../utils/lazy';
+import * as cf from '../utils/common-flags';
+import * as compose from '../utils/compose';
+import type { Application, ApplicationType, BalenaSDK } from 'balena-sdk';
 import {
+	appToFleetFlagMsg,
 	buildArgDeprecation,
 	dockerignoreHelp,
 	registrySecretsHelp,
-} from '../../utils/messages';
-import type { ComposeCliFlags, ComposeOpts } from '../../utils/compose-types';
-import { buildProject, composeCliFlags } from '../../utils/compose_ts';
-import type { BuildOpts, DockerCliFlags } from '../../utils/docker';
-import { dockerCliFlags } from '../../utils/docker';
+	warnify,
+} from '../utils/messages';
+import type { ComposeCliFlags, ComposeOpts } from '../utils/compose-types';
+import { buildProject, composeCliFlags } from '../utils/compose_ts';
+import type { BuildOpts, DockerCliFlags } from '../utils/docker';
+import { dockerCliFlags } from '../utils/docker';
+import { isV13 } from '../utils/version';
 
-type ComposeGenerateOptsParam = Parameters<typeof compose.generateOpts>[0];
-
-interface PrepareBuildOpts
-	extends ComposeCliFlags,
-		DockerCliFlags,
-		ComposeGenerateOptsParam {
+interface FlagsDef extends ComposeCliFlags, DockerCliFlags {
 	arch?: string;
 	deviceType?: string;
+	application?: string;
 	fleet?: string;
+	source?: string; // Not part of command profile - source param copied here.
+	help: void;
+}
+
+interface ArgsDef {
 	source?: string;
 }
 
@@ -73,73 +72,81 @@ ${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',
 		'$ balena build --dockerHost my.docker.host --dockerPort 2376 --ca ca.pem --key key.pem --cert cert.pem -f myFleet',
 	];
 
-	public static args = {
-		source: Args.string({ description: 'path of project source directory' }),
-	};
+	public static args = [
+		{
+			name: 'source',
+			description: 'path of project source directory',
+		},
+	];
 
-	public static flags = {
-		arch: Flags.string({
+	public static usage = 'build [source]';
+
+	public static flags: flags.Input<FlagsDef> = {
+		arch: flags.string({
 			description: 'the architecture to build for',
 			char: 'A',
 		}),
-		deviceType: Flags.string({
+		deviceType: flags.string({
 			description: 'the type of device this build is for',
 			char: 'd',
 		}),
+		...(isV13() ? {} : { application: cf.application }),
 		fleet: cf.fleet,
 		...composeCliFlags,
 		...dockerCliFlags,
+		// NOTE: Not supporting -h for help, because of clash with -h in DockerCliFlags
+		// Revisit this in future release.
+		help: flags.help({}),
 	};
 
 	public static primary = true;
 
 	public async run() {
-		const { args: params, flags: options } = await this.parse(BuildCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			BuildCmd,
+		);
 
-		const Logger = await import('../../utils/logger');
-		const { checkLoggedInIf } = await import('../../utils/patterns');
+		if (options.application && process.stderr.isTTY) {
+			console.error(warnify(appToFleetFlagMsg));
+		}
+		options.application ||= options.fleet;
 
-		await checkLoggedInIf(!!options.fleet);
+		await Command.checkLoggedInIf(!!options.application);
 
 		(await import('events')).defaultMaxListeners = 1000;
 
 		const sdk = getBalenaSdk();
 
-		const logger = Logger.getLogger();
+		const logger = await Command.getLogger();
 		logger.logDebug('Parsing input...');
 
-		const prepareBuildOpts = {
-			...options,
-			source: params.source,
-		};
+		// `build` accepts `source` as a parameter, but compose expects it as an option
+		options.source = params.source;
+		delete params.source;
 
-		await this.resolveArchFromDeviceType(sdk, prepareBuildOpts);
-
-		await this.validateOptions(prepareBuildOpts, sdk);
+		await this.validateOptions(options, sdk);
 
 		// Build args are under consideration for removal - warn user
-		if (prepareBuildOpts.buildArg) {
+		if (options.buildArg) {
 			console.log(buildArgDeprecation);
 		}
 
-		const app = await this.getAppAndResolveArch(prepareBuildOpts);
+		const app = await this.getAppAndResolveArch(options);
 
-		const { docker, buildOpts, composeOpts } =
-			await this.prepareBuild(prepareBuildOpts);
+		const { docker, buildOpts, composeOpts } = await this.prepareBuild(options);
 
 		try {
 			await this.buildProject(docker, logger, composeOpts, {
-				appType: app?.application_type?.[0],
-				arch: prepareBuildOpts.arch!,
-				deviceType: prepareBuildOpts.deviceType!,
-				buildEmulated: prepareBuildOpts.emulated,
+				app,
+				arch: options.arch!,
+				deviceType: options.deviceType!,
+				buildEmulated: options.emulated,
 				buildOpts,
 			});
 		} catch (err) {
@@ -151,20 +158,22 @@ ${dockerignoreHelp}
 		logger.logSuccess('Build succeeded!');
 	}
 
-	protected async validateOptions(opts: PrepareBuildOpts, sdk: BalenaSDK) {
+	protected async validateOptions(opts: FlagsDef, sdk: BalenaSDK) {
 		// Validate option combinations
 		if (
-			(opts.fleet == null && (opts.arch == null || opts.deviceType == null)) ||
-			(opts.fleet != null && (opts.arch != null || opts.deviceType != null))
+			(opts.application == null &&
+				(opts.arch == null || opts.deviceType == null)) ||
+			(opts.application != null &&
+				(opts.arch != null || opts.deviceType != null))
 		) {
-			const { ExpectedError } = await import('../../errors');
+			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)',
 			);
 		}
 
 		// Validate project directory
-		const { validateProjectDirectory } = await import('../../utils/compose_ts');
+		const { validateProjectDirectory } = await import('../utils/compose_ts');
 		const { dockerfilePath, registrySecrets } = await validateProjectDirectory(
 			sdk,
 			{
@@ -179,54 +188,18 @@ ${dockerignoreHelp}
 		opts['registry-secrets'] = registrySecrets;
 	}
 
-	protected async resolveArchFromDeviceType(
-		sdk: BalenaSDK,
-		opts: PrepareBuildOpts,
-	) {
-		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: PrepareBuildOpts) {
-		if (opts.fleet) {
-			const { getAppWithArch } = await import('../../utils/helpers');
-			const app = await getAppWithArch(opts.fleet);
+	protected async getAppAndResolveArch(opts: FlagsDef) {
+		if (opts.application) {
+			const { getAppWithArch } = await import('../utils/helpers');
+			const app = await getAppWithArch(opts.application);
 			opts.arch = app.arch;
 			opts.deviceType = app.is_for__device_type[0].slug;
 			return app;
 		}
 	}
 
-	protected async prepareBuild(options: PrepareBuildOpts) {
-		const { getDocker, generateBuildOpts } = await import('../../utils/docker');
+	protected async prepareBuild(options: FlagsDef) {
+		const { getDocker, generateBuildOpts } = await import('../utils/docker');
 		const [docker, buildOpts, composeOpts] = await Promise.all([
 			getDocker(options),
 			generateBuildOpts(options),
@@ -247,24 +220,24 @@ ${dockerignoreHelp}
 	 *   buildEmulated
 	 *   buildOpts: arguments to forward to docker build command
 	 *
-	 * @param {Dockerode} docker
+	 * @param {DockerToolbelt} docker
 	 * @param {Logger} logger
 	 * @param {ComposeOpts} composeOpts
 	 * @param opts
 	 */
 	protected async buildProject(
 		docker: import('dockerode'),
-		logger: import('../../utils/logger'),
+		logger: import('../utils/logger'),
 		composeOpts: ComposeOpts,
 		opts: {
-			appType?: Pick<ApplicationType, 'supports_multicontainer'>;
+			app?: Application;
 			arch: string;
 			deviceType: string;
 			buildEmulated: boolean;
 			buildOpts: BuildOpts;
 		},
 	) {
-		const { loadProject } = await import('../../utils/compose_ts');
+		const { loadProject } = await import('../utils/compose_ts');
 
 		const project = await loadProject(
 			logger,
@@ -273,10 +246,11 @@ ${dockerignoreHelp}
 			opts.buildOpts.t,
 		);
 
+		const appType = (opts.app?.application_type as ApplicationType[])?.[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' +
@@ -297,6 +271,7 @@ ${dockerignoreHelp}
 			inlineLogs: composeOpts.inlineLogs,
 			convertEol: composeOpts.convertEol,
 			dockerfilePath: composeOpts.dockerfilePath,
+			nogitignore: composeOpts.nogitignore, // v13: delete this line
 			multiDockerignore: composeOpts.multiDockerignore,
 		});
 	}

lib/commands/config/generate.ts

@@ -15,16 +15,35 @@
  * limitations under the License.
  */
 
-import { Flags, Command } from '@oclif/core';
-import type { Interfaces } from '@oclif/core';
+import { flags } from '@oclif/command';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, getCliForm, stripIndent } from '../../utils/lazy';
 import {
 	applicationIdInfo,
-	devModeInfo,
-	secureBootInfo,
+	appToFleetFlagMsg,
+	warnify,
 } from '../../utils/messages';
-import type { BalenaSDK, PineDeferred } from 'balena-sdk';
+import { isV13 } from '../../utils/version';
+import type { PineDeferred } from 'balena-sdk';
+
+interface FlagsDef {
+	version: string; // OS version
+	application?: string;
+	app?: string; // application alias
+	fleet?: string;
+	device?: string;
+	deviceApiKey?: string;
+	deviceType?: string;
+	'generate-device-api-key': boolean;
+	output?: string;
+	// Options for non-interactive configuration
+	network?: string;
+	wifiSsid?: string;
+	wifiKey?: string;
+	appUpdatePollInterval?: string;
+	help: void;
+}
 
 export default class ConfigGenerateCmd extends Command {
 	public static description = stripIndent`
@@ -34,10 +53,6 @@ export default class ConfigGenerateCmd extends Command {
 
 		The target balenaOS version must be specified with the --version option.
 
-		${devModeInfo.split('\n').join('\n\t\t')}
-
-		${secureBootInfo.split('\n').join('\n\t\t')}
-
 		To configure an image for a fleet of mixed device types, use the --fleet option
 		alongside the --deviceType option to specify the target device type.
 
@@ -50,103 +65,94 @@ export default class ConfigGenerateCmd extends Command {
 	public static examples = [
 		'$ balena config generate --device 7cf02a6 --version 2.12.7',
 		'$ balena config generate --device 7cf02a6 --version 2.12.7 --generate-device-api-key',
-		'$ balena config generate --device 7cf02a6 --version 2.12.7 --deviceApiKey <existingDeviceKey>',
+		'$ balena config generate --device 7cf02a6 --version 2.12.7 --device-api-key <existingDeviceKey>',
 		'$ balena config generate --device 7cf02a6 --version 2.12.7 --output config.json',
-		'$ balena config generate --fleet myorg/fleet --version 2.12.7 --dev',
-		'$ balena config generate --fleet myorg/fleet --version 2.12.7 --secureBoot',
-		'$ balena config generate --fleet myorg/fleet --version 2.12.7 --deviceType fincm3',
-		'$ balena config generate --fleet myorg/fleet --version 2.12.7 --output config.json',
-		'$ balena config generate --fleet myorg/fleet --version 2.12.7 --network wifi --wifiSsid mySsid --wifiKey abcdefgh --appUpdatePollInterval 15',
+		'$ balena config generate --fleet MyFleet --version 2.12.7',
+		'$ balena config generate --fleet myorg/myfleet --version 2.12.7',
+		'$ balena config generate --fleet MyFleet --version 2.12.7 --deviceType fincm3',
+		'$ balena config generate --fleet MyFleet --version 2.12.7 --output config.json',
+		'$ balena config generate --fleet MyFleet --version 2.12.7 --network wifi --wifiSsid mySsid --wifiKey abcdefgh --appUpdatePollInterval 15',
 	];
 
-	public static flags = {
-		version: Flags.string({
+	public static usage = 'config generate';
+
+	public static flags: flags.Input<FlagsDef> = {
+		version: flags.string({
 			description: 'a balenaOS version',
 			required: true,
 		}),
-		fleet: { ...cf.fleet, exclusive: ['device'] },
-		dev: cf.dev,
-		secureBoot: cf.secureBoot,
-		device: {
-			...cf.device,
-			exclusive: [
-				'fleet',
-				'provisioning-key-name',
-				'provisioning-key-expiry-date',
-			],
-		},
-		deviceApiKey: Flags.string({
+		...(isV13()
+			? {}
+			: {
+					application: {
+						...cf.application,
+						exclusive: ['app', 'fleet', 'device'],
+					},
+					app: { ...cf.app, exclusive: ['application', 'fleet', 'device'] },
+					appUpdatePollInterval: flags.string({
+						description: 'DEPRECATED alias for --updatePollInterval',
+					}),
+			  }),
+		fleet: { ...cf.fleet, exclusive: ['application', 'app', 'device'] },
+		device: { ...cf.device, exclusive: ['application', 'app', 'fleet'] },
+		deviceApiKey: flags.string({
 			description:
 				'custom device key - note that this is only supported on balenaOS 2.0.3+',
 			char: 'k',
 		}),
-		deviceType: Flags.string({
+		deviceType: flags.string({
 			description:
-				"device type slug (run 'balena device-type list' for possible values)",
+				"device type slug (run 'balena devices supported' for possible values)",
 		}),
-		'generate-device-api-key': Flags.boolean({
+		'generate-device-api-key': flags.boolean({
 			description: 'generate a fresh device key for the device',
 		}),
-		output: Flags.string({
+		output: flags.string({
 			description: 'path of output file',
 			char: 'o',
 		}),
 		// Options for non-interactive configuration
-		network: Flags.string({
+		network: flags.string({
 			description: 'the network type to use: ethernet or wifi',
 			options: ['ethernet', 'wifi'],
 		}),
-		wifiSsid: Flags.string({
+		wifiSsid: flags.string({
 			description:
 				'the wifi ssid to use (used only if --network is set to wifi)',
 		}),
-		wifiKey: Flags.string({
+		wifiKey: flags.string({
 			description:
 				'the wifi key to use (used only if --network is set to wifi)',
 		}),
-		appUpdatePollInterval: Flags.string({
+		appUpdatePollInterval: flags.string({
 			description:
-				'supervisor cloud polling interval in minutes (e.g. for device variables)',
-		}),
-		'provisioning-key-name': Flags.string({
-			description: 'custom key name assigned to generated provisioning api key',
-			exclusive: ['device'],
-		}),
-		'provisioning-key-expiry-date': Flags.string({
-			description:
-				'expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)',
-			exclusive: ['device'],
+				'supervisor cloud polling interval in minutes (e.g. for variable updates)',
 		}),
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
-	public async getApplication(balena: BalenaSDK, fleet: string) {
-		const { getApplication } = await import('../../utils/sdk');
-		return await getApplication(balena, fleet, {
-			$select: 'slug',
-			$expand: {
-				is_for__device_type: { $select: 'slug' },
-			},
-		});
-	}
-
 	public async run() {
-		const { flags: options } = await this.parse(ConfigGenerateCmd);
+		const { flags: options } = this.parse<FlagsDef, {}>(ConfigGenerateCmd);
+
+		const { getApplication } = await import('../../utils/sdk');
+
 		const balena = getBalenaSdk();
 
 		await this.validateOptions(options);
 
 		let resourceDeviceType: string;
-		let application: Awaited<ReturnType<typeof this.getApplication>> | null =
-			null;
+		let application: ApplicationWithDeviceType | null = null;
 		let device:
 			| (DeviceWithDeviceType & { belongs_to__application: PineDeferred })
 			| null = null;
 		if (options.device != null) {
-			const rawDevice = await balena.models.device.get(options.device, {
-				$expand: { is_of__device_type: { $select: 'slug' } },
-			});
+			const { tryAsInteger } = await import('../../utils/validation');
+			const rawDevice = await balena.models.device.get(
+				tryAsInteger(options.device),
+				{ $expand: { is_of__device_type: { $select: 'slug' } } },
+			);
 			if (!rawDevice.belongs_to__application) {
 				const { ExpectedError } = await import('../../errors');
 				throw new ExpectedError(stripIndent`
@@ -159,51 +165,43 @@ export default class ConfigGenerateCmd extends Command {
 			resourceDeviceType = device.is_of__device_type[0].slug;
 		} else {
 			// Disambiguate application (if is a number, it could either be an ID or a numerical name)
-			application = await this.getApplication(balena, options.fleet!);
+			application = (await getApplication(balena, options.application!, {
+				$expand: {
+					is_for__device_type: { $select: 'slug' },
+				},
+			})) as ApplicationWithDeviceType;
 			resourceDeviceType = application.is_for__device_type[0].slug;
 		}
 
 		const deviceType = options.deviceType || resourceDeviceType;
 
+		const deviceManifest = await balena.models.device.getManifestBySlug(
+			deviceType,
+		);
+
 		// Check compatibility if application and deviceType provided
-		if (options.fleet && options.deviceType) {
+		if (options.application && options.deviceType) {
+			const appDeviceManifest = await balena.models.device.getManifestBySlug(
+				resourceDeviceType,
+			);
+
 			const helpers = await import('../../utils/helpers');
 			if (
-				!(await helpers.areDeviceTypesCompatible(
-					resourceDeviceType,
-					deviceType,
-				))
+				!helpers.areDeviceTypesCompatible(appDeviceManifest, deviceManifest)
 			) {
-				const { ExpectedError } = await import('../../errors');
-				throw new ExpectedError(
-					`Device type ${options.deviceType} is incompatible with fleet ${options.fleet}`,
+				throw new balena.errors.BalenaInvalidDeviceType(
+					`Device type ${options.deviceType} is incompatible with fleet ${options.application}`,
 				);
 			}
 		}
 
-		const deviceManifest =
-			await balena.models.config.getDeviceTypeManifestBySlug(deviceType);
-
-		const { validateSecureBootOptionAndWarn } = await import(
-			'../../utils/config'
-		);
-		await validateSecureBootOptionAndWarn(
-			options.secureBoot,
-			deviceType,
-			options.version,
-		);
-
 		// Prompt for values
 		// Pass params as an override: if there is any param with exactly the same name as a
 		// required option, that value is used (and the corresponding question is not asked)
 		const answers = await getCliForm().run(deviceManifest.options, {
-			override: { ...options, app: options.fleet, application: options.fleet },
+			override: options,
 		});
 		answers.version = options.version;
-		answers.developmentMode = options.dev;
-		answers.secureBoot = options.secureBoot;
-		answers.provisioningKeyName = options['provisioning-key-name'];
-		answers.provisioningKeyExpiryDate = options['provisioning-key-expiry-date'];
 
 		// Generate config
 		const { generateDeviceConfig, generateApplicationConfig } = await import(
@@ -243,21 +241,22 @@ export default class ConfigGenerateCmd extends Command {
 	protected readonly deviceTypeNotAllowedMessage =
 		'The --deviceType option can only be used alongside the --fleet option';
 
-	protected async validateOptions(
-		options: Interfaces.InferredFlags<typeof ConfigGenerateCmd.flags>,
-	) {
+	protected async validateOptions(options: FlagsDef) {
 		const { ExpectedError } = await import('../../errors');
 
-		if (options.device == null && options.fleet == null) {
+		if ((options.application || options.app) && process.stderr.isTTY) {
+			console.error(warnify(appToFleetFlagMsg));
+		}
+		options.application ||= options.app || options.fleet;
+		// Prefer options.application over options.app
+		delete options.app;
+
+		if (options.device == null && options.application == null) {
 			throw new ExpectedError(this.missingDeviceOrAppMessage);
 		}
 
-		if (!options.fleet && options.deviceType) {
+		if (!options.application && options.deviceType) {
 			throw new ExpectedError(this.deviceTypeNotAllowedMessage);
 		}
-		const { normalizeOsVersion } = await import('../../utils/normalization');
-		options.version = normalizeOsVersion(options.version);
-		const { validateDevOptionAndWarn } = await import('../../utils/config');
-		await validateDevOptionAndWarn(options.dev, options.version);
 	}
 }

lib/commands/config/inject.ts

@@ -15,42 +15,59 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getVisuals, stripIndent } from '../../utils/lazy';
 
+interface FlagsDef {
+	type: string;
+	drive?: string;
+	help: void;
+}
+
+interface ArgsDef {
+	file: string;
+}
+
 export default class ConfigInjectCmd extends Command {
 	public static description = stripIndent`
-		Inject a config.json file to a balenaOS image or attached media.
+		Inject a configuration file into a device or OS image.
 
-		Inject a 'config.json' file to a balenaOS image file or attached SD card or
-		USB stick.
+		Inject a config.json file to a mounted filesystem, e.g. the SD card of a
+		provisioned device or balenaOS image.
 
-		Documentation for the balenaOS 'config.json' file can be found at:
-		https://www.balena.io/docs/reference/OS/configuration/
+		Note: if using a private/custom device type, please ensure you are logged in
+		('balena login' command). Public device types do not require logging in.
 	`;
 
 	public static examples = [
-		'$ balena config inject my/config.json',
-		'$ balena config inject my/config.json --drive /dev/disk2',
+		'$ balena config inject my/config.json --type raspberrypi3',
+		'$ balena config inject my/config.json --type raspberrypi3 --drive /dev/disk2',
 	];
 
-	public static args = {
-		file: Args.string({
+	public static args = [
+		{
+			name: 'file',
 			description: 'the path to the config.json file to inject',
 			required: true,
-		}),
-	};
+		},
+	];
 
-	public static flags = {
+	public static usage = 'config inject <file>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		type: cf.deviceType,
 		drive: cf.driveOrImg,
+		help: cf.help,
 	};
 
 	public static root = true;
-	public static offlineCompatible = true;
 
 	public async run() {
-		const { args: params, flags: options } = await this.parse(ConfigInjectCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			ConfigInjectCmd,
+		);
 
 		const { safeUmount } = await import('../../utils/umount');
 
@@ -64,12 +81,7 @@ export default class ConfigInjectCmd extends Command {
 		);
 
 		const config = await import('balena-config-json');
-		await config.write(
-			drive,
-			// Will be removed in the next major of balena-config-json
-			undefined,
-			configJSON,
-		);
+		await config.write(drive, options.type, configJSON);
 
 		console.info('Done');
 	}

lib/commands/config/read.ts

@@ -15,37 +15,44 @@
  * limitations under the License.
  */
 
-import { Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getVisuals, stripIndent } from '../../utils/lazy';
 
+interface FlagsDef {
+	type: string;
+	drive?: string;
+	help: void;
+}
+
 export default class ConfigReadCmd extends Command {
 	public static description = stripIndent`
-		Read the config.json file of a balenaOS image or attached media.
+		Read the configuration of a device or OS image.
 
-		Read the 'config.json' file of a balenaOS image file or attached SD card or
-		USB stick.
-
-		Documentation for the balenaOS 'config.json' file can be found at:
-		https://www.balena.io/docs/reference/OS/configuration/
+		Read the config.json file from the mounted filesystem,
+		e.g. the SD card of a provisioned device or balenaOS image.
 	`;
 
 	public static examples = [
-		'$ balena config read',
-		'$ balena config read --drive /dev/disk2',
-		'$ balena config read --drive balena.img',
+		'$ balena config read --type raspberrypi3',
+		'$ balena config read --type raspberrypi3 --drive /dev/disk2',
 	];
 
-	public static flags = {
+	public static usage = 'config read';
+
+	public static flags: flags.Input<FlagsDef> = {
+		type: cf.deviceType,
 		drive: cf.driveOrImg,
-		json: cf.json,
+		help: cf.help,
 	};
 
+	public static authenticated = true;
+
 	public static root = true;
-	public static offlineCompatible = true;
 
 	public async run() {
-		const { flags: options } = await this.parse(ConfigReadCmd);
+		const { flags: options } = this.parse<FlagsDef, {}>(ConfigReadCmd);
 
 		const { safeUmount } = await import('../../utils/umount');
 
@@ -54,13 +61,9 @@ export default class ConfigReadCmd extends Command {
 		await safeUmount(drive);
 
 		const config = await import('balena-config-json');
-		const configJSON = await config.read(drive);
+		const configJSON = await config.read(drive, options.type);
 
-		if (options.json) {
-			console.log(JSON.stringify(configJSON, null, 4));
-		} else {
-			const prettyjson = await import('prettyjson');
-			console.log(prettyjson.render(configJSON));
-		}
+		const prettyjson = await import('prettyjson');
+		console.info(prettyjson.render(configJSON));
 	}
 }

lib/commands/config/reconfigure.ts

@@ -15,45 +15,48 @@
  * limitations under the License.
  */
 
-import { Flags, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getVisuals, stripIndent } from '../../utils/lazy';
 
+interface FlagsDef {
+	type: string;
+	drive?: string;
+	advanced: boolean;
+	help: void;
+}
+
 export default class ConfigReconfigureCmd extends Command {
 	public static description = stripIndent`
-		Interactively reconfigure a balenaOS image file or attached media.
+		Interactively reconfigure a device or OS image.
 
-		Interactively reconfigure a balenaOS image file or attached media.
-
-		This command extracts the device UUID from the 'config.json' file of the
-		chosen balenaOS image file or attached media, and then passes the UUID as
-		the '--device' argument to the 'balena os configure' command.
-
-		For finer-grained or scripted control of the operation, use the
-		'balena config read' and 'balena os configure' commands separately.
+		Interactively reconfigure a provisioned device or OS image.
 `;
 	public static examples = [
-		'$ balena config reconfigure',
-		'$ balena config reconfigure --drive /dev/disk3',
-		'$ balena config reconfigure --drive balena.img --advanced',
+		'$ balena config reconfigure --type raspberrypi3',
+		'$ balena config reconfigure --type raspberrypi3 --advanced',
+		'$ balena config reconfigure --type raspberrypi3 --drive /dev/disk2',
 	];
 
-	public static flags = {
+	public static usage = 'config reconfigure';
+
+	public static flags: flags.Input<FlagsDef> = {
+		type: cf.deviceType,
 		drive: cf.driveOrImg,
-		advanced: Flags.boolean({
+		advanced: flags.boolean({
 			description: 'show advanced commands',
 			char: 'v',
 		}),
-		version: Flags.string({
-			description: 'balenaOS version, for example "2.32.0" or "2.44.0+rev1"',
-		}),
+		help: cf.help,
 	};
 
 	public static authenticated = true;
+
 	public static root = true;
 
 	public async run() {
-		const { flags: options } = await this.parse(ConfigReconfigureCmd);
+		const { flags: options } = this.parse<FlagsDef, {}>(ConfigReconfigureCmd);
 
 		const { safeUmount } = await import('../../utils/umount');
 
@@ -62,20 +65,10 @@ export default class ConfigReconfigureCmd extends Command {
 		await safeUmount(drive);
 
 		const config = await import('balena-config-json');
-		const { uuid } = await config.read(drive);
+		const { uuid } = await config.read(drive, options.type);
 		await safeUmount(drive);
 
-		if (!uuid) {
-			const { ExpectedError } = await import('../../errors');
-			throw new ExpectedError(
-				`Error: UUID not found in 'config.json' file for '${drive}'`,
-			);
-		}
-
 		const configureCommand = ['os', 'configure', drive, '--device', uuid];
-		if (options.version) {
-			configureCommand.push('--version', options.version);
-		}
 		if (options.advanced) {
 			configureCommand.push('--advanced');
 		}

lib/commands/config/write.ts

@@ -15,47 +15,65 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getVisuals, stripIndent } from '../../utils/lazy';
 
+interface FlagsDef {
+	type: string;
+	drive?: string;
+	help: void;
+}
+
+interface ArgsDef {
+	key: string;
+	value: string;
+}
+
 export default class ConfigWriteCmd extends Command {
 	public static description = stripIndent`
-		Write a key-value pair to the config.json file of an OS image or attached media.
+		Write a key-value pair to configuration of a device or OS image.
 
-		Write a key-value pair to the 'config.json' file of a balenaOS image file or
-		attached SD card or USB stick.
-
-		Documentation for the balenaOS 'config.json' file can be found at:
-		https://www.balena.io/docs/reference/OS/configuration/
+		Write a key-value pair to the config.json file on the mounted filesystem,
+		e.g. the SD card of a provisioned device or balenaOS image.
 	`;
 
 	public static examples = [
-		'$ balena config write ntpServers "0.resinio.pool.ntp.org 1.resinio.pool.ntp.org"',
-		'$ balena config write --drive /dev/disk2 hostname custom-hostname',
-		'$ balena config write --drive balena.img os.network.connectivity.interval 300',
+		'$ balena config write --type raspberrypi3 username johndoe',
+		'$ balena config write --type raspberrypi3 --drive /dev/disk2 username johndoe',
+		'$ balena config write --type raspberrypi3 files.network/settings "..."',
 	];
 
-	public static args = {
-		key: Args.string({
+	public static args = [
+		{
+			name: 'key',
 			description: 'the key of the config parameter to write',
 			required: true,
-		}),
-		value: Args.string({
+		},
+		{
+			name: 'value',
 			description: 'the value of the config parameter to write',
 			required: true,
-		}),
+		},
+	];
+
+	public static usage = 'config write <key> <value>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		type: cf.deviceType,
+		drive: cf.driveOrImg,
+		help: cf.help,
 	};
 
-	public static flags = {
-		drive: cf.driveOrImg,
-	};
+	public static authenticated = true;
 
 	public static root = true;
-	public static offlineCompatible = true;
 
 	public async run() {
-		const { args: params, flags: options } = await this.parse(ConfigWriteCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			ConfigWriteCmd,
+		);
 
 		const { denyMount, safeUmount } = await import('../../utils/umount');
 
@@ -64,19 +82,14 @@ export default class ConfigWriteCmd extends Command {
 		await safeUmount(drive);
 
 		const config = await import('balena-config-json');
-		const configJSON = await config.read(drive);
+		const configJSON = await config.read(drive, options.type);
 
 		console.info(`Setting ${params.key} to ${params.value}`);
 		ConfigWriteCmd.updateConfigJson(configJSON, params.key, params.value);
 
 		await denyMount(drive, async () => {
 			await safeUmount(drive);
-			await config.write(
-				drive,
-				// Will be removed in the next major of balena-config-json
-				undefined,
-				configJSON,
-			);
+			await config.write(drive, options.type, configJSON);
 		});
 
 		console.info('Done');

lib/commands/deploy.ts

@@ -15,51 +15,57 @@
  * limitations under the License.
  */
 
-import { Args, Flags, Command } from '@oclif/core';
-import type { ImageDescriptor } from '@balena/compose/dist/parse';
-import { ExpectedError } from '../../errors';
-import { getBalenaSdk, getChalk, stripIndent } from '../../utils/lazy';
+import { flags } from '@oclif/command';
+import type { ImageDescriptor } from 'resin-compose-parse';
+
+import Command from '../command';
+import { ExpectedError } from '../errors';
+import { getBalenaSdk, getChalk, stripIndent } from '../utils/lazy';
 import {
 	dockerignoreHelp,
 	registrySecretsHelp,
 	buildArgDeprecation,
-} from '../../utils/messages';
-import * as ca from '../../utils/common-args';
-import * as compose from '../../utils/compose';
+} from '../utils/messages';
+import * as ca from '../utils/common-args';
+import * as compose from '../utils/compose';
 import type {
 	BuiltImage,
 	ComposeCliFlags,
 	ComposeOpts,
 	Release as ComposeReleaseInfo,
-} from '../../utils/compose-types';
-import type { BuildOpts, DockerCliFlags } from '../../utils/docker';
+} from '../utils/compose-types';
+import type { BuildOpts, DockerCliFlags } from '../utils/docker';
 import {
 	applyReleaseTagKeysAndValues,
 	buildProject,
 	composeCliFlags,
 	isBuildConfig,
 	parseReleaseTagKeysAndValues,
-} from '../../utils/compose_ts';
-import { dockerCliFlags } from '../../utils/docker';
-import type { ApplicationType, DeviceType, Release } from 'balena-sdk';
+} from '../utils/compose_ts';
+import { dockerCliFlags } from '../utils/docker';
+import type {
+	Application,
+	ApplicationType,
+	DeviceType,
+	Release,
+} from 'balena-sdk';
 
-interface ApplicationWithArch {
-	id: number;
+interface ApplicationWithArch extends Application {
 	arch: string;
-	is_for__device_type: [Pick<DeviceType, 'slug'>];
-	application_type: [Pick<ApplicationType, 'slug' | 'supports_multicontainer'>];
 }
 
-// TODO: For this special one we can't use Interfaces.InferredFlags/InferredArgs
-// because of the 'registry-secrets' type which is defined in the actual code
-// as a path (string | undefined) but then the cli turns it into an object
 interface FlagsDef extends ComposeCliFlags, DockerCliFlags {
 	source?: string;
 	build: boolean;
 	nologupload: boolean;
 	'release-tag'?: string[];
 	draft: boolean;
-	note?: string;
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+	image?: string;
 }
 
 export default class DeployCmd extends Command {
@@ -95,31 +101,35 @@ ${dockerignoreHelp}
 	public static examples = [
 		'$ balena deploy myFleet',
 		'$ balena deploy myorg/myfleet --build --source myBuildDir/',
-		'$ balena deploy myorg/myfleet --build --source myBuildDir/ --note "this is the note for this release"',
 		'$ balena deploy myorg/myfleet myRepo/myImage',
 		'$ balena deploy myFleet myRepo/myImage --release-tag key1 "" key2 "value2 with spaces"',
 	];
 
-	public static args = {
-		fleet: ca.fleetRequired,
-		image: Args.string({ description: 'the image to deploy' }),
-	};
+	public static args = [
+		ca.fleetRequired,
+		{
+			name: 'image',
+			description: 'the image to deploy',
+		},
+	];
 
-	public static flags = {
-		source: Flags.string({
+	public static usage = 'deploy <fleet> [image]';
+
+	public static flags: flags.Input<FlagsDef> = {
+		source: flags.string({
 			description:
 				'specify an alternate source directory; default is the working directory',
 			char: 's',
 		}),
-		build: Flags.boolean({
+		build: flags.boolean({
 			description: 'force a rebuild before deploy',
 			char: 'b',
 		}),
-		nologupload: Flags.boolean({
+		nologupload: flags.boolean({
 			description:
 				"don't upload build logs to the dashboard with image (if building)",
 		}),
-		'release-tag': Flags.string({
+		'release-tag': flags.string({
 			description: stripIndent`
 				Set release tags if the image deployment is successful. Multiple
 				arguments may be provided, alternating tag keys and values (see examples).
@@ -127,7 +137,7 @@ ${dockerignoreHelp}
 			`,
 			multiple: true,
 		}),
-		draft: Flags.boolean({
+		draft: flags.boolean({
 			description: stripIndent`
 				Deploy the release as a draft. Draft releases are ignored
 				by the 'track latest' release policy but can be used through release pinning.
@@ -135,9 +145,11 @@ ${dockerignoreHelp}
 				as final by default unless this option is given.`,
 			default: false,
 		}),
-		note: Flags.string({ description: 'The notes for this release' }),
 		...composeCliFlags,
 		...dockerCliFlags,
+		// NOTE: Not supporting -h for help, because of clash with -h in DockerCliFlags
+		// Revisit this in future release.
+		help: flags.help({}),
 	};
 
 	public static authenticated = true;
@@ -145,13 +157,13 @@ ${dockerignoreHelp}
 	public static primary = true;
 
 	public async run() {
-		const { args: params, flags: options } = await this.parse(DeployCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeployCmd,
+		);
 
 		(await import('events')).defaultMaxListeners = 1000;
 
-		const Logger = await import('../../utils/logger');
-
-		const logger = Logger.getLogger();
+		const logger = await Command.getLogger();
 		logger.logDebug('Parsing input...');
 
 		const { fleet, image } = params;
@@ -169,7 +181,7 @@ ${dockerignoreHelp}
 
 		const sdk = getBalenaSdk();
 		const { getRegistrySecrets, validateProjectDirectory } = await import(
-			'../../utils/compose_ts'
+			'../utils/compose_ts'
 		);
 
 		const { releaseTagKeys, releaseTagValues } = parseReleaseTagKeysAndValues(
@@ -177,7 +189,7 @@ ${dockerignoreHelp}
 		);
 
 		if (image) {
-			(options as FlagsDef)['registry-secrets'] = await getRegistrySecrets(
+			options['registry-secrets'] = await getRegistrySecrets(
 				sdk,
 				options['registry-secrets'],
 			);
@@ -190,16 +202,16 @@ ${dockerignoreHelp}
 					registrySecretsPath: options['registry-secrets'],
 				});
 			options.dockerfile = dockerfilePath;
-			(options as FlagsDef)['registry-secrets'] = registrySecrets;
+			options['registry-secrets'] = registrySecrets;
 		}
 
-		const helpers = await import('../../utils/helpers');
+		const helpers = await import('../utils/helpers');
 		const app = await helpers.getAppWithArch(fleet);
 
-		const dockerUtils = await import('../../utils/docker');
+		const dockerUtils = await import('../utils/docker');
 		const [docker, buildOpts, composeOpts] = await Promise.all([
 			dockerUtils.getDocker(options),
-			dockerUtils.generateBuildOpts(options as FlagsDef),
+			dockerUtils.generateBuildOpts(options),
 			compose.generateOpts(options),
 		]);
 
@@ -219,14 +231,11 @@ ${dockerignoreHelp}
 			releaseTagKeys,
 			releaseTagValues,
 		);
-		if (options.note) {
-			await sdk.models.release.setNote(release.id, options.note);
-		}
 	}
 
 	async deployProject(
 		docker: import('dockerode'),
-		logger: import('../../utils/logger'),
+		logger: import('../utils/logger'),
 		composeOpts: ComposeOpts,
 		opts: {
 			app: ApplicationWithArch; // the application instance to deploy to
@@ -244,10 +253,10 @@ ${dockerignoreHelp}
 		const doodles = await import('resin-doodles');
 		const sdk = getBalenaSdk();
 		const { deployProject: $deployProject, loadProject } = await import(
-			'../../utils/compose_ts'
+			'../utils/compose_ts'
 		);
 
-		const appType = opts.app.application_type[0];
+		const appType = (opts.app?.application_type as ApplicationType[])?.[0];
 
 		try {
 			const project = await loadProject(
@@ -304,12 +313,13 @@ ${dockerignoreHelp}
 					projectName: project.name,
 					composition: compositionToBuild,
 					arch: opts.app.arch,
-					deviceType: opts.app.is_for__device_type[0].slug,
+					deviceType: (opts.app?.is_for__device_type as DeviceType[])?.[0].slug,
 					emulated: opts.buildEmulated,
 					buildOpts: opts.buildOpts,
 					inlineLogs: composeOpts.inlineLogs,
 					convertEol: composeOpts.convertEol,
 					dockerfilePath: composeOpts.dockerfilePath,
+					nogitignore: composeOpts.nogitignore, // v13: delete this line
 					multiDockerignore: composeOpts.multiDockerignore,
 				});
 				builtImagesByService = _.keyBy(builtImages, 'serviceName');
@@ -325,17 +335,17 @@ ${dockerignoreHelp}
 			);
 
 			let release: Release | ComposeReleaseInfo['release'];
-			if (appType.slug === 'legacy-v1' || appType.slug === 'legacy-v2') {
-				const { deployLegacy } = require('../../utils/deploy-legacy');
+			if (appType?.is_legacy) {
+				const { deployLegacy } = require('../utils/deploy-legacy');
 
 				const msg = getChalk().yellow(
 					'Target fleet requires legacy deploy method.',
 				);
 				logger.logWarn(msg);
 
-				const [token, { username }, url, options] = await Promise.all([
+				const [token, username, url, options] = await Promise.all([
 					sdk.auth.getToken(),
-					sdk.auth.getUserInfo(),
+					sdk.auth.whoami(),
 					sdk.settings.get('balenaUrl'),
 					{
 						// opts.appName may be prefixed by 'owner/', unlike opts.app.app_name
@@ -358,17 +368,23 @@ ${dockerignoreHelp}
 					$select: ['commit'],
 				});
 			} else {
+				const [userId, auth, apiEndpoint] = await Promise.all([
+					sdk.auth.getUserId(),
+					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,
-					project.descriptors,
 				);
 			}
 

lib/commands/device/deactivate.ts

@@ -15,10 +15,21 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
 
+interface FlagsDef {
+	yes: boolean;
+	help: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
+
 export default class DeviceDeactivateCmd extends Command {
 	public static description = stripIndent`
 		Deactivate a device.
@@ -33,22 +44,27 @@ export default class DeviceDeactivateCmd extends Command {
 		'$ balena device deactivate 7cf02a6 --yes',
 	];
 
-	public static args = {
-		uuid: Args.string({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description: 'the UUID of the device to be deactivated',
 			required: true,
-		}),
-	};
+		},
+	];
 
-	public static flags = {
+	public static usage = 'device deactivate <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
 		yes: cf.yes,
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params, flags: options } =
-			await this.parse(DeviceDeactivateCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceDeactivateCmd,
+		);
 
 		const balena = getBalenaSdk();
 		const patterns = await import('../../utils/patterns');

lib/commands/device/identify.ts

@@ -15,10 +15,22 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import { tryAsInteger } from '../../utils/validation';
 import { ExpectedError } from '../../errors';
 
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
+
 export default class DeviceIdentifyCmd extends Command {
 	public static description = stripIndent`
 		Identify a device.
@@ -27,17 +39,25 @@ export default class DeviceIdentifyCmd extends Command {
 		`;
 	public static examples = ['$ balena device identify 23c73a1'];
 
-	public static args = {
-		uuid: Args.string({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description: 'the uuid of the device to identify',
+			parse: (dev) => tryAsInteger(dev),
 			required: true,
-		}),
+		},
+	];
+
+	public static usage = 'device identify <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params } = await this.parse(DeviceIdentifyCmd);
+		const { args: params } = this.parse<FlagsDef, ArgsDef>(DeviceIdentifyCmd);
 
 		const balena = getBalenaSdk();
 

lib/commands/device/index.ts

@@ -15,17 +15,21 @@
  * limitations under the License.
  */
 
-import { Flags, Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { expandForAppName } from '../../utils/helpers';
 import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
-import { jsonInfo } from '../../utils/messages';
+import { appToFleetOutputMsg, warnify } from '../../utils/messages';
+import { tryAsInteger } from '../../utils/validation';
+import { isV13 } from '../../utils/version';
 
 import type { Application, Release } from 'balena-sdk';
 
 interface ExtendedDevice extends DeviceWithDeviceType {
 	dashboard_url?: string;
-	fleet: string; // 'org/name' slug
+	application_name?: string;
 	device_type?: string;
 	commit?: string;
 	last_seen?: string;
@@ -40,112 +44,85 @@ interface ExtendedDevice extends DeviceWithDeviceType {
 	undervoltage_detected?: boolean;
 }
 
+interface FlagsDef {
+	help: void;
+	v13: boolean;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
+
 export default class DeviceCmd extends Command {
 	public static description = stripIndent`
 		Show info about a single device.
 
 		Show information about a single device.
-
-		${jsonInfo.split('\n').join('\n\t\t')}
 		`;
-	public static examples = [
-		'$ balena device 7cf02a6',
-		'$ balena device 7cf02a6 --view',
-		'$ balena device 7cf02a6 --json',
+	public static examples = ['$ balena device 7cf02a6'];
+
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
+			description: 'the device uuid',
+			parse: (dev) => tryAsInteger(dev),
+			required: true,
+		},
 	];
 
-	public static args = {
-		uuid: Args.string({
-			description: 'the device uuid',
-			required: true,
-		}),
-	};
+	public static usage = 'device <uuid>';
 
-	public static flags = {
-		json: cf.json,
-		view: Flags.boolean({
-			default: false,
-			description: 'open device dashboard page',
-		}),
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
+		v13: cf.v13,
 	};
 
 	public static authenticated = true;
 	public static primary = true;
 
 	public async run() {
-		const { args: params, flags: options } = await this.parse(DeviceCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceCmd,
+		);
+		const useAppWord = !options.v13 && !isV13();
 
 		const balena = getBalenaSdk();
 
-		let device: ExtendedDevice;
-		if (options.json) {
-			const [deviceBase, deviceComputed] = await Promise.all([
-				balena.models.device.get(params.uuid, {
-					$expand: {
-						device_tag: {
-							$select: ['tag_key', 'value'],
-						},
-						...expandForAppName.$expand,
-					},
-				}),
-				balena.models.device.get(params.uuid, {
-					$select: [
-						'overall_status',
-						'overall_progress',
-						'should_be_running__release',
-					],
-				}),
-			]);
-
-			device = {
-				...deviceBase,
-				...deviceComputed,
-			} as ExtendedDevice;
-		} else {
-			device = (await balena.models.device.get(params.uuid, {
-				$select: [
-					'device_name',
-					'id',
-					'overall_status',
-					'is_online',
-					'ip_address',
-					'mac_address',
-					'last_connectivity_event',
-					'uuid',
-					'supervisor_version',
-					'is_web_accessible',
-					'note',
-					'os_version',
-					'memory_usage',
-					'memory_total',
-					'public_address',
-					'storage_block_device',
-					'storage_usage',
-					'storage_total',
-					'cpu_usage',
-					'cpu_temp',
-					'cpu_id',
-					'is_undervolted',
-				],
-				...expandForAppName,
-			})) as ExtendedDevice;
-		}
-
-		if (options.view) {
-			const open = await import('open');
-			const dashboardUrl = balena.models.device.getDashboardUrl(device.uuid);
-			await open(dashboardUrl, { wait: false });
-			return;
-		}
-
+		const device = (await balena.models.device.get(params.uuid, {
+			$select: [
+				'device_name',
+				'id',
+				'overall_status',
+				'is_online',
+				'ip_address',
+				'mac_address',
+				'last_connectivity_event',
+				'uuid',
+				'supervisor_version',
+				'is_web_accessible',
+				'note',
+				'os_version',
+				'memory_usage',
+				'memory_total',
+				'public_address',
+				'storage_block_device',
+				'storage_usage',
+				'storage_total',
+				'cpu_usage',
+				'cpu_temp',
+				'cpu_id',
+				'is_undervolted',
+			],
+			...expandForAppName,
+		})) as ExtendedDevice;
 		device.status = device.overall_status;
 
 		device.dashboard_url = balena.models.device.getDashboardUrl(device.uuid);
 
 		const belongsToApplication =
 			device.belongs_to__application as Application[];
-		device.fleet = belongsToApplication?.[0]
-			? belongsToApplication[0].slug
+		device.application_name = belongsToApplication?.[0]
+			? belongsToApplication[0].app_name
 			: 'N/a';
 
 		device.device_type = device.is_of__device_type[0].slug;
@@ -193,9 +170,8 @@ export default class DeviceCmd extends Command {
 			);
 		}
 
-		if (options.json) {
-			console.log(JSON.stringify(device, null, 4));
-			return;
+		if (useAppWord && process.stderr.isTTY) {
+			console.error(warnify(appToFleetOutputMsg));
 		}
 
 		console.log(
@@ -208,7 +184,7 @@ export default class DeviceCmd extends Command {
 				'ip_address',
 				'public_address',
 				'mac_address',
-				'fleet',
+				useAppWord ? 'application_name' : 'application_name => FLEET',
 				'last_seen',
 				'uuid',
 				'commit',

lib/commands/device/init.ts

@@ -15,71 +15,64 @@
  * limitations under the License.
  */
 
-import { Flags, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
-import { applicationIdInfo } from '../../utils/messages';
+import {
+	applicationIdInfo,
+	appToFleetFlagMsg,
+	warnify,
+} from '../../utils/messages';
 import { runCommand } from '../../utils/helpers';
+import { isV13 } from '../../utils/version';
 
 interface FlagsDef {
+	application?: string;
+	app?: string;
 	fleet?: string;
 	yes: boolean;
 	advanced: boolean;
 	'os-version'?: string;
 	drive?: string;
 	config?: string;
-	'provisioning-key-name'?: string;
-	'provisioning-key-expiry-date'?: string;
+	help: void;
 }
 
 export default class DeviceInitCmd extends Command {
 	public static description = stripIndent`
 		Initialize a device with balenaOS.
 
-		Register a new device in the selected fleet, download the OS image for the
-		fleet's default device type, configure the image and write it to an SD card.
-		This command effectively combines several other balena CLI commands in one,
-		namely:
+		Initialize a device by downloading the OS image of the specified fleet
+		and writing it to an SD Card.
 
-		'balena device register'
-		'balena os download'
-		'balena os build-config' or 'balena config generate'
-		'balena os configure'
-		'balena os local flash'
-
-		Possible arguments for the '--fleet', '--os-version' and '--drive' options can
-		be listed respectively with the commands:
-
-		'balena fleet list'
-		'balena os versions'
-		'balena util available-drives'
-
-		If the '--fleet' or '--drive' options are omitted, interactive menus will be
-		presented with values to choose from. If the '--os-version' option is omitted,
-		the latest released OS version for the fleet's default device type will be used.
+		If the --fleet option is omitted, it will be prompted for interactively.
 
 		${applicationIdInfo.split('\n').join('\n\t\t')}
-
-		Image configuration questions will be asked interactively unless a pre-configured
-		'config.json' file is provided with the '--config' option.  The file can be
-		generated with the 'balena config generate' or 'balena os build-config' commands.
 	`;
 
 	public static examples = [
 		'$ balena device init',
+		'$ balena device init --fleet MyFleet',
 		'$ balena device init -f myorg/myfleet',
-		'$ balena device init --fleet myFleet --os-version 2.101.7 --drive /dev/disk5 --config config.json --yes',
-		'$ balena device init --fleet myFleet --os-version 2.83.21+rev1.prod --drive /dev/disk5 --config config.json --yes',
 	];
 
-	public static flags = {
+	public static usage = 'device init';
+
+	public static flags: flags.Input<FlagsDef> = {
+		...(isV13()
+			? {}
+			: {
+					application: cf.application,
+					app: cf.app,
+			  }),
 		fleet: cf.fleet,
 		yes: cf.yes,
-		advanced: Flags.boolean({
+		advanced: flags.boolean({
 			char: 'v',
 			description: 'show advanced configuration options',
 		}),
-		'os-version': Flags.string({
+		'os-version': flags.string({
 			description: stripIndent`
 				exact version number, or a valid semver range,
 				or 'latest' (includes pre-releases),
@@ -89,22 +82,16 @@ export default class DeviceInitCmd extends Command {
 				`,
 		}),
 		drive: cf.drive,
-		config: Flags.string({
+		config: flags.string({
 			description: 'path to the config JSON file, see `balena os build-config`',
 		}),
-		'provisioning-key-name': Flags.string({
-			description: 'custom key name assigned to generated provisioning api key',
-		}),
-		'provisioning-key-expiry-date': Flags.string({
-			description:
-				'expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)',
-		}),
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { flags: options } = await this.parse(DeviceInitCmd);
+		const { flags: options } = this.parse<FlagsDef, {}>(DeviceInitCmd);
 
 		// Imports
 		const { promisify } = await import('util');
@@ -114,26 +101,36 @@ export default class DeviceInitCmd extends Command {
 		tmp.setGracefulCleanup();
 		const { downloadOSImage } = await import('../../utils/cloud');
 		const { getApplication } = await import('../../utils/sdk');
-		const Logger = await import('../../utils/logger');
 
-		const logger = Logger.getLogger();
+		const logger = await Command.getLogger();
 		const balena = getBalenaSdk();
 
+		if ((options.application || options.app) && process.stderr.isTTY) {
+			console.error(warnify(appToFleetFlagMsg));
+		}
+		// Consolidate application options
+		options.application ||= options.app || options.fleet;
+		delete options.app;
+
 		// Get application and
-		const application = options.fleet
-			? await getApplication(balena, options.fleet, {
-					$select: ['id', 'slug'],
-					$expand: {
-						is_for__device_type: {
-							$select: 'slug',
-						},
+		const application = (await getApplication(
+			balena,
+			options['application'] ||
+				(
+					await (await import('../../utils/patterns')).selectApplication()
+				).id,
+			{
+				$expand: {
+					is_for__device_type: {
+						$select: 'slug',
 					},
-				})
-			: await (await import('../../utils/patterns')).selectApplication();
+				},
+			},
+		)) as ApplicationWithDeviceType;
 
 		// Register new device
 		const deviceUuid = balena.models.device.generateUniqueKey();
-		console.info(`Registering to ${application.slug}: ${deviceUuid}`);
+		console.info(`Registering to ${application.app_name}: ${deviceUuid}`);
 		await balena.models.device.register(application.id, deviceUuid);
 		const device = await balena.models.device.get(deviceUuid);
 
@@ -155,7 +152,7 @@ export default class DeviceInitCmd extends Command {
 			try {
 				logger.logDebug(`Process failed, removing device ${device.uuid}`);
 				await balena.models.device.remove(device.uuid);
-			} catch {
+			} catch (e) {
 				// Ignore removal failures, and throw original error
 			}
 			throw e;
@@ -176,21 +173,6 @@ export default class DeviceInitCmd extends Command {
 		} else if (options.advanced) {
 			configureCommand.push('--advanced');
 		}
-
-		if (options['provisioning-key-name']) {
-			configureCommand.push(
-				'--provisioning-key-name',
-				options['provisioning-key-name'],
-			);
-		}
-
-		if (options['provisioning-key-expiry-date']) {
-			configureCommand.push(
-				'--provisioning-key-expiry-date',
-				options['provisioning-key-expiry-date'],
-			);
-		}
-
 		await runCommand(configureCommand);
 	}
 

lib/commands/device/local-mode.ts

@@ -15,8 +15,23 @@
  * limitations under the License.
  */
 
-import { Flags, Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import { tryAsInteger } from '../../utils/validation';
+
+interface FlagsDef {
+	enable: boolean;
+	disable: boolean;
+	status: boolean;
+	help?: void;
+}
+
+interface ArgsDef {
+	uuid: string | number;
+}
 
 export default class DeviceLocalModeCmd extends Command {
 	public static description = stripIndent`
@@ -33,33 +48,39 @@ export default class DeviceLocalModeCmd extends Command {
 		'$ balena device local-mode 23c73a1 --status',
 	];
 
-	public static args = {
-		uuid: Args.string({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description: 'the uuid of the device to manage',
+			parse: (dev) => tryAsInteger(dev),
 			required: true,
-		}),
-	};
+		},
+	];
 
-	public static flags = {
-		enable: Flags.boolean({
+	public static usage = 'device local-mode <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		enable: flags.boolean({
 			description: 'enable local mode',
 			exclusive: ['disable', 'status'],
 		}),
-		disable: Flags.boolean({
+		disable: flags.boolean({
 			description: 'disable local mode',
 			exclusive: ['enable', 'status'],
 		}),
-		status: Flags.boolean({
+		status: flags.boolean({
 			description: 'output boolean indicating local mode status',
 			exclusive: ['enable', 'disable'],
 		}),
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params, flags: options } =
-			await this.parse(DeviceLocalModeCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceLocalModeCmd,
+		);
 
 		const balena = getBalenaSdk();
 

lib/commands/device/move.ts

@@ -0,0 +1,212 @@
+/**
+ * @license
+ * Copyright 2016-2020 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import type {
+	BalenaSDK,
+	Device,
+	DeviceType,
+	PineTypedResult,
+} from 'balena-sdk';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
+import { ExpectedError } from '../../errors';
+import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import {
+	applicationIdInfo,
+	appToFleetFlagMsg,
+	warnify,
+} from '../../utils/messages';
+import { isV13 } from '../../utils/version';
+
+type ExtendedDevice = PineTypedResult<
+	Device,
+	typeof import('../../utils/helpers').expandForAppNameAndCpuArch
+> & {
+	application_name?: string;
+};
+
+interface FlagsDef {
+	application?: string;
+	app?: string;
+	fleet?: string;
+	help: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
+
+export default class DeviceMoveCmd extends Command {
+	public static description = stripIndent`
+		Move one or more devices to another fleet.
+
+		Move one or more devices to another fleet.
+
+		If --fleet is omitted, the fleet will be prompted for interactively.
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+	`;
+
+	public static examples = [
+		'$ balena device move 7cf02a6',
+		'$ balena device move 7cf02a6,dc39e52',
+		'$ balena device move 7cf02a6 --fleet MyNewFleet',
+		'$ balena device move 7cf02a6 -f myorg/mynewfleet',
+	];
+
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
+			description:
+				'comma-separated list (no blank spaces) of device UUIDs to be moved',
+			required: true,
+		},
+	];
+
+	public static usage = 'device move <uuid(s)>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		...(isV13() ? {} : { app: cf.app, application: cf.application }),
+		fleet: cf.fleet,
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+
+	public async run() {
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceMoveCmd,
+		);
+
+		if ((options.application || options.app) && process.stderr.isTTY) {
+			console.error(warnify(appToFleetFlagMsg));
+		}
+		options.application ||= options.app || options.fleet;
+
+		const balena = getBalenaSdk();
+
+		const { tryAsInteger } = await import('../../utils/validation');
+		const { expandForAppNameAndCpuArch } = await import('../../utils/helpers');
+
+		// Parse ids string into array of correct types
+		const deviceIds: Array<string | number> = params.uuid
+			.split(',')
+			.map((id) => tryAsInteger(id));
+
+		// Get devices
+		const devices = await Promise.all(
+			deviceIds.map(
+				(uuid) =>
+					balena.models.device.get(
+						uuid,
+						expandForAppNameAndCpuArch,
+					) as Promise<ExtendedDevice>,
+			),
+		);
+
+		// Map application name for each device
+		for (const device of devices) {
+			const belongsToApplication = device.belongs_to__application;
+			device.application_name = belongsToApplication?.[0]
+				? belongsToApplication[0].app_name
+				: 'N/a';
+		}
+
+		// Disambiguate application (if is a number, it could either be an ID or a numerical name)
+		const { getApplication } = await import('../../utils/sdk');
+
+		// Get destination application
+		const application = options.application
+			? await getApplication(balena, options.application)
+			: await this.interactivelySelectApplication(balena, devices);
+
+		// Move each device
+		for (const uuid of deviceIds) {
+			try {
+				await balena.models.device.move(uuid, application.id);
+				console.info(`Device ${uuid} was moved to fleet ${application.slug}`);
+			} catch (err) {
+				console.info(`${err.message}, uuid: ${uuid}`);
+				process.exitCode = 1;
+			}
+		}
+	}
+
+	async interactivelySelectApplication(
+		balena: BalenaSDK,
+		devices: ExtendedDevice[],
+	) {
+		const { getExpandedProp } = await import('../../utils/pine');
+		// deduplicate the slugs
+		const deviceCpuArchs = Array.from(
+			new Set(
+				devices.map(
+					(d) => d.is_of__device_type[0].is_of__cpu_architecture[0].slug,
+				),
+			),
+		);
+
+		const deviceTypeOptions = {
+			$select: 'slug',
+			$expand: {
+				is_of__cpu_architecture: {
+					$select: 'slug',
+				},
+			},
+		} as const;
+		const deviceTypes = (await balena.models.deviceType.getAllSupported(
+			deviceTypeOptions,
+		)) as Array<PineTypedResult<DeviceType, typeof deviceTypeOptions>>;
+
+		const compatibleDeviceTypeSlugs = new Set(
+			deviceTypes
+				.filter((deviceType) => {
+					const deviceTypeArch = getExpandedProp(
+						deviceType.is_of__cpu_architecture,
+						'slug',
+					)!;
+					return deviceCpuArchs.every((deviceCpuArch) =>
+						balena.models.os.isArchitectureCompatibleWith(
+							deviceCpuArch,
+							deviceTypeArch,
+						),
+					);
+				})
+				.map((deviceType) => deviceType.slug),
+		);
+
+		const patterns = await import('../../utils/patterns');
+		try {
+			const application = await patterns.selectApplication(
+				(app) =>
+					compatibleDeviceTypeSlugs.has(app.is_for__device_type[0].slug) &&
+					devices.some((device) => device.application_name !== app.app_name),
+				true,
+			);
+			return application;
+		} catch (err) {
+			if (!compatibleDeviceTypeSlugs.size) {
+				throw new ExpectedError(
+					`${err.message}\nDo all devices have a compatible architecture?`,
+				);
+			}
+			throw err;
+		}
+	}
+}

lib/commands/device/os-update.ts

@@ -0,0 +1,146 @@
+/**
+ * @license
+ * Copyright 2016-2020 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
+import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy';
+import { tryAsInteger } from '../../utils/validation';
+import type { Device } from 'balena-sdk';
+import { ExpectedError } from '../../errors';
+
+interface FlagsDef {
+	version?: string;
+	yes: boolean;
+	help: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
+
+export default class DeviceOsUpdateCmd extends Command {
+	public static description = stripIndent`
+		Start a Host OS update for a device.
+
+		Start a Host OS update for a device.
+
+		Note this command will ask for confirmation interactively.
+		This can be avoided by passing the \`--yes\` option.
+
+		Requires balenaCloud; will not work with openBalena or standalone balenaOS.
+		`;
+	public static examples = [
+		'$ balena device os-update 23c73a1',
+		'$ balena device os-update 23c73a1 --version 2.31.0+rev1.prod',
+	];
+
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
+			description: 'the uuid of the device to update',
+			parse: (dev) => tryAsInteger(dev),
+			required: true,
+		},
+	];
+
+	public static usage = 'device os-update <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		version: flags.string({
+			description: 'a balenaOS version',
+		}),
+		yes: cf.yes,
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+
+	public async run() {
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceOsUpdateCmd,
+		);
+
+		const sdk = getBalenaSdk();
+
+		// Get device info
+		const { uuid, is_of__device_type, os_version, os_variant } =
+			(await sdk.models.device.get(params.uuid, {
+				$select: ['uuid', 'os_version', 'os_variant'],
+				$expand: {
+					is_of__device_type: {
+						$select: 'slug',
+					},
+				},
+			})) as DeviceWithDeviceType;
+
+		// Get current device OS version
+		const currentOsVersion = sdk.models.device.getOsVersion({
+			os_version,
+			os_variant,
+		} as Device);
+		if (!currentOsVersion) {
+			throw new ExpectedError(
+				'The current os version of the device is not available',
+			);
+		}
+
+		// Get supported OS update versions
+		const hupVersionInfo = await sdk.models.os.getSupportedOsUpdateVersions(
+			is_of__device_type[0].slug,
+			currentOsVersion,
+		);
+		if (hupVersionInfo.versions.length === 0) {
+			throw new ExpectedError(
+				'There are no available Host OS update targets for this device',
+			);
+		}
+
+		// Get target OS version
+		let targetOsVersion = options.version;
+		if (targetOsVersion != null) {
+			if (!hupVersionInfo.versions.includes(targetOsVersion)) {
+				throw new ExpectedError(
+					`The provided version ${targetOsVersion} is not in the Host OS update targets for this device`,
+				);
+			}
+		} else {
+			targetOsVersion = await getCliForm().ask({
+				message: 'Target OS version',
+				type: 'list',
+				choices: hupVersionInfo.versions.map((version) => ({
+					name:
+						hupVersionInfo.recommended === version
+							? `${version} (recommended)`
+							: version,
+					value: version,
+				})),
+			});
+		}
+
+		const patterns = await import('../../utils/patterns');
+		// Confirm and start update
+		await patterns.confirm(
+			options.yes || false,
+			'Host OS updates require a device restart when they complete. Are you sure you want to proceed?',
+		);
+
+		await sdk.models.device.startOsUpdate(uuid, targetOsVersion);
+		await patterns.awaitDeviceOsUpdate(uuid, targetOsVersion);
+	}
+}

lib/commands/device/public-url.ts

@@ -15,9 +15,26 @@
  * limitations under the License.
  */
 
-import { Flags, Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
 import { ExpectedError } from '../../errors';
+import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import { tryAsInteger } from '../../utils/validation';
+
+interface FlagsDef {
+	enable: boolean;
+	disable: boolean;
+	status: boolean;
+	help?: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+	// Optional hidden arg to support old command format
+	legacyUuid?: string;
+}
 
 export default class DevicePublicUrlCmd extends Command {
 	public static description = stripIndent`
@@ -26,6 +43,9 @@ export default class DevicePublicUrlCmd extends Command {
 		This command will output the current public URL for the
 		specified device.  It can also enable or disable the URL,
 		or output the enabled status, using the respective options.
+
+		The old command style 'balena device public-url enable <uuid>'
+		is deprecated, but still supported.
 	`;
 
 	public static examples = [
@@ -35,33 +55,64 @@ export default class DevicePublicUrlCmd extends Command {
 		'$ balena device public-url 23c73a1 --status',
 	];
 
-	public static args = {
-		uuid: Args.string({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description: 'the uuid of the device to manage',
+			parse: (dev) => tryAsInteger(dev),
 			required: true,
-		}),
-	};
+		},
+		{
+			// Optional hidden arg to support old command format
+			name: 'legacyUuid',
+			parse: (dev) => tryAsInteger(dev),
+			hidden: true,
+		},
+	];
 
-	public static flags = {
-		enable: Flags.boolean({
+	public static usage = 'device public-url <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		enable: flags.boolean({
 			description: 'enable the public URL',
 			exclusive: ['disable', 'status'],
 		}),
-		disable: Flags.boolean({
+		disable: flags.boolean({
 			description: 'disable the public URL',
 			exclusive: ['enable', 'status'],
 		}),
-		status: Flags.boolean({
+		status: flags.boolean({
 			description: 'determine if public URL is enabled',
 			exclusive: ['enable', 'disable'],
 		}),
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params, flags: options } =
-			await this.parse(DevicePublicUrlCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DevicePublicUrlCmd,
+		);
+
+		// Legacy command format support.
+		// Previously this command used the following format
+		// (changed due to oclif technicalities):
+		//   `balena device public-url enable|disable|status <uuid>`
+		if (params.legacyUuid) {
+			const action = params.uuid;
+			if (!['enable', 'disable', 'status'].includes(action)) {
+				throw new ExpectedError(
+					`Unexpected arguments: ${params.uuid} ${params.legacyUuid}`,
+				);
+			}
+
+			options.enable = action === 'enable';
+			options.disable = action === 'disable';
+			options.status = action === 'status';
+			params.uuid = params.legacyUuid;
+			delete params.legacyUuid;
+		}
 
 		const balena = getBalenaSdk();
 

lib/commands/device/purge.ts

@@ -15,9 +15,20 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy';
 
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
+
 export default class DevicePurgeCmd extends Command {
 	public static description = stripIndent`
 		Purge data from a device.
@@ -33,26 +44,36 @@ export default class DevicePurgeCmd extends Command {
 		'$ balena device purge 55d43b3,23c73a1',
 	];
 
-	public static args = {
-		uuid: Args.string({
+	public static usage = 'device purge <uuid>';
+
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description: 'comma-separated list (no blank spaces) of device UUIDs',
 			required: true,
-		}),
+		},
+	];
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params } = await this.parse(DevicePurgeCmd);
+		const { args: params } = this.parse<FlagsDef, ArgsDef>(DevicePurgeCmd);
 
+		const { tryAsInteger } = await import('../../utils/validation');
 		const balena = getBalenaSdk();
 		const ux = getCliUx();
 
-		const deviceUuids = params.uuid.split(',');
+		const deviceIds = params.uuid.split(',').map((id) => {
+			return tryAsInteger(id);
+		});
 
-		for (const uuid of deviceUuids) {
-			ux.action.start(`Purging data from device ${uuid}`);
-			await balena.models.device.purge(uuid);
+		for (const deviceId of deviceIds) {
+			ux.action.start(`Purging data from device ${deviceId}`);
+			await balena.models.device.purge(deviceId);
 			ux.action.stop();
 		}
 	}

lib/commands/device/reboot.ts

@@ -15,9 +15,21 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import { tryAsInteger } from '../../utils/validation';
+
+interface FlagsDef {
+	force: boolean;
+	help: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
 
 export default class DeviceRebootCmd extends Command {
 	public static description = stripIndent`
@@ -27,21 +39,28 @@ export default class DeviceRebootCmd extends Command {
 		`;
 	public static examples = ['$ balena device reboot 23c73a1'];
 
-	public static args = {
-		uuid: Args.string({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description: 'the uuid of the device to reboot',
+			parse: (dev) => tryAsInteger(dev),
 			required: true,
-		}),
-	};
+		},
+	];
 
-	public static flags = {
+	public static usage = 'device reboot <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
 		force: cf.force,
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params, flags: options } = await this.parse(DeviceRebootCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceRebootCmd,
+		);
 
 		const balena = getBalenaSdk();
 

lib/commands/device/register.ts

@@ -15,11 +15,23 @@
  * limitations under the License.
  */
 
-import { Flags, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
 import * as ca from '../../utils/common-args';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
 import { applicationIdInfo } from '../../utils/messages';
 
+interface FlagsDef {
+	uuid?: string;
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+}
+
 export default class DeviceRegisterCmd extends Command {
 	public static description = stripIndent`
 		Register a new device.
@@ -35,47 +47,38 @@ export default class DeviceRegisterCmd extends Command {
 		'$ balena device register MyFleet',
 		'$ balena device register MyFleet --uuid <uuid>',
 		'$ balena device register myorg/myfleet --uuid <uuid>',
-		'$ balena device register myorg/myfleet --uuid <uuid> --deviceType <deviceTypeSlug>',
 	];
 
-	public static args = {
-		fleet: ca.fleetRequired,
-	};
+	public static args: Array<IArg<any>> = [ca.fleetRequired];
 
-	public static flags = {
-		uuid: Flags.string({
+	public static usage = 'device register <fleet>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		uuid: flags.string({
 			description: 'custom uuid',
 			char: 'u',
 		}),
-		deviceType: Flags.string({
-			description:
-				"device type slug (run 'balena device-type list' for possible values)",
-		}),
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params, flags: options } =
-			await this.parse(DeviceRegisterCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceRegisterCmd,
+		);
 
 		const { getApplication } = await import('../../utils/sdk');
 
 		const balena = getBalenaSdk();
 
-		const application = await getApplication(balena, params.fleet, {
-			$select: ['id', 'slug'],
-		});
+		const application = await getApplication(balena, params.fleet);
 		const uuid = options.uuid ?? balena.models.device.generateUniqueKey();
 
-		console.info(`Registering to ${application.slug}: ${uuid}`);
+		console.info(`Registering to ${application.app_name}: ${uuid}`);
 
-		const result = await balena.models.device.register(
-			application.id,
-			uuid,
-			options.deviceType,
-		);
+		const result = await balena.models.device.register(application.id, uuid);
 
-		return result.uuid;
+		return result && result.uuid;
 	}
 }

lib/commands/device/rename.ts

@@ -15,8 +15,21 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy';
+import { tryAsInteger } from '../../utils/validation';
+
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+	newName?: string;
+}
 
 export default class DeviceRenameCmd extends Command {
 	public static description = stripIndent`
@@ -31,20 +44,29 @@ export default class DeviceRenameCmd extends Command {
 		'$ balena device rename 7cf02a6 MyPi',
 	];
 
-	public static args = {
-		uuid: Args.string({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description: 'the uuid of the device to rename',
+			parse: (dev) => tryAsInteger(dev),
 			required: true,
-		}),
-		newName: Args.string({
+		},
+		{
+			name: 'newName',
 			description: 'the new name for the device',
-		}),
+		},
+	];
+
+	public static usage = 'device rename <uuid> [newName]';
+
+	public static flags: flags.Input<FlagsDef> = {
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params } = await this.parse(DeviceRenameCmd);
+		const { args: params } = this.parse<FlagsDef, ArgsDef>(DeviceRenameCmd);
 
 		const balena = getBalenaSdk();
 

lib/commands/device/restart.ts

@@ -15,7 +15,10 @@
  * limitations under the License.
  */
 
-import { Flags, Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy';
 import type {
 	BalenaSDK,
@@ -23,6 +26,15 @@ import type {
 	CurrentServiceWithCommit,
 } from 'balena-sdk';
 
+interface FlagsDef {
+	help: void;
+	service?: string;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
+
 export default class DeviceRestartCmd extends Command {
 	public static description = stripIndent`
 		Restart containers on a device.
@@ -43,42 +55,51 @@ export default class DeviceRestartCmd extends Command {
 		'$ balena device restart 23c73a1 -s myService1,myService2',
 	];
 
-	public static args = {
-		uuid: Args.string({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description:
 				'comma-separated list (no blank spaces) of device UUIDs to restart',
 			required: true,
-		}),
-	};
+		},
+	];
 
-	public static flags = {
-		service: Flags.string({
+	public static usage = 'device restart <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
+		service: flags.string({
 			description:
 				'comma-separated list (no blank spaces) of service names to restart',
 			char: 's',
 		}),
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params, flags: options } = await this.parse(DeviceRestartCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceRestartCmd,
+		);
 
+		const { tryAsInteger } = await import('../../utils/validation');
 		const balena = getBalenaSdk();
 		const ux = getCliUx();
 
-		const deviceUuids = params.uuid.split(',');
+		const deviceIds = params.uuid.split(',').map((id) => {
+			return tryAsInteger(id);
+		});
 		const serviceNames = options.service?.split(',');
 
-		// Iterate sequentially through deviceUuids.
+		// Iterate sequentially through deviceIds.
 		// We may later want to add a batching feature,
 		// so that n devices are processed in parallel
-		for (const uuid of deviceUuids) {
-			ux.action.start(`Restarting services on device ${uuid}`);
+		for (const deviceId of deviceIds) {
+			ux.action.start(`Restarting services on device ${deviceId}`);
 			if (serviceNames) {
-				await this.restartServices(balena, uuid, serviceNames);
+				await this.restartServices(balena, deviceId, serviceNames);
 			} else {
-				await this.restartAllServices(balena, uuid);
+				await this.restartAllServices(balena, deviceId);
 			}
 			ux.action.stop();
 		}
@@ -86,7 +107,7 @@ export default class DeviceRestartCmd extends Command {
 
 	async restartServices(
 		balena: BalenaSDK,
-		deviceUuid: string,
+		deviceId: number | string,
 		serviceNames: string[],
 	) {
 		const { ExpectedError, instanceOf } = await import('../../errors');
@@ -95,7 +116,7 @@ export default class DeviceRestartCmd extends Command {
 		// Get device
 		let device: DeviceWithServiceDetails<CurrentServiceWithCommit>;
 		try {
-			device = await balena.models.device.getWithServiceDetails(deviceUuid, {
+			device = await balena.models.device.getWithServiceDetails(deviceId, {
 				$expand: {
 					is_running__release: { $select: 'commit' },
 				},
@@ -103,7 +124,7 @@ export default class DeviceRestartCmd extends Command {
 		} catch (e) {
 			const { BalenaDeviceNotFound } = await import('balena-errors');
 			if (instanceOf(e, BalenaDeviceNotFound)) {
-				throw new ExpectedError(`Device ${deviceUuid} not found.`);
+				throw new ExpectedError(`Device ${deviceId} not found.`);
 			} else {
 				throw e;
 			}
@@ -115,7 +136,7 @@ export default class DeviceRestartCmd extends Command {
 		serviceNames.forEach((service) => {
 			if (!device.current_services[service]) {
 				throw new ExpectedError(
-					`Service ${service} not found on device ${deviceUuid}.`,
+					`Service ${service} not found on device ${deviceId}.`,
 				);
 			}
 		});
@@ -134,7 +155,7 @@ export default class DeviceRestartCmd extends Command {
 			if (serviceContainer) {
 				restartPromises.push(
 					balena.models.device.restartService(
-						deviceUuid,
+						deviceId,
 						serviceContainer.image_id,
 					),
 				);
@@ -145,32 +166,32 @@ export default class DeviceRestartCmd extends Command {
 			await Promise.all(restartPromises);
 		} catch (e) {
 			if (e.message.toLowerCase().includes('no online device')) {
-				throw new ExpectedError(`Device ${deviceUuid} is not online.`);
+				throw new ExpectedError(`Device ${deviceId} is not online.`);
 			} else {
 				throw e;
 			}
 		}
 	}
 
-	async restartAllServices(balena: BalenaSDK, deviceUuid: string) {
+	async restartAllServices(balena: BalenaSDK, deviceId: number | string) {
 		// Note: device.restartApplication throws `BalenaDeviceNotFound: Device not found` if device not online.
-		// Need to use device.get first to distinguish between non-existant and disconnected devices.
+		// Need to use device.get first to distinguish between non-existant and offline devices.
 		// Remove this workaround when SDK issue resolved: https://github.com/balena-io/balena-sdk/issues/649
 		const { instanceOf, ExpectedError } = await import('../../errors');
 		try {
-			const device = await balena.models.device.get(deviceUuid);
+			const device = await balena.models.device.get(deviceId);
 			if (!device.is_online) {
-				throw new ExpectedError(`Device ${deviceUuid} is not online.`);
+				throw new ExpectedError(`Device ${deviceId} is not online.`);
 			}
 		} catch (e) {
 			const { BalenaDeviceNotFound } = await import('balena-errors');
 			if (instanceOf(e, BalenaDeviceNotFound)) {
-				throw new ExpectedError(`Device ${deviceUuid} not found.`);
+				throw new ExpectedError(`Device ${deviceId} not found.`);
 			} else {
 				throw e;
 			}
 		}
 
-		await balena.models.device.restartApplication(deviceUuid);
+		await balena.models.device.restartApplication(deviceId);
 	}
 }

lib/commands/device/rm.ts

@@ -15,9 +15,21 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import { tryAsInteger } from '../../utils/validation';
+
+interface FlagsDef {
+	yes: boolean;
+	help: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
 
 export default class DeviceRmCmd extends Command {
 	public static description = stripIndent`
@@ -34,22 +46,28 @@ export default class DeviceRmCmd extends Command {
 		'$ balena device rm 7cf02a6 --yes',
 	];
 
-	public static args = {
-		uuid: Args.string({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description:
 				'comma-separated list (no blank spaces) of device UUIDs to be removed',
 			required: true,
-		}),
-	};
+		},
+	];
 
-	public static flags = {
+	public static usage = 'device rm <uuid(s)>';
+
+	public static flags: flags.Input<FlagsDef> = {
 		yes: cf.yes,
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params, flags: options } = await this.parse(DeviceRmCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceRmCmd,
+		);
 
 		const balena = getBalenaSdk();
 		const patterns = await import('../../utils/patterns');
@@ -66,7 +84,7 @@ export default class DeviceRmCmd extends Command {
 		// Remove
 		for (const uuid of uuids) {
 			try {
-				await balena.models.device.remove(uuid);
+				await balena.models.device.remove(tryAsInteger(uuid));
 			} catch (err) {
 				console.info(`${err.message}, uuid: ${uuid}`);
 				process.exitCode = 1;

lib/commands/device/shutdown.ts

@@ -15,11 +15,23 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import type { IArg } from '@oclif/parser/lib/args';
+import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
+import { tryAsInteger } from '../../utils/validation';
 import { ExpectedError } from '../../errors';
 
+interface FlagsDef {
+	force: boolean;
+	help: void;
+}
+
+interface ArgsDef {
+	uuid: string;
+}
+
 export default class DeviceShutdownCmd extends Command {
 	public static description = stripIndent`
 		Shutdown a device.
@@ -28,22 +40,28 @@ export default class DeviceShutdownCmd extends Command {
 		`;
 	public static examples = ['$ balena device shutdown 23c73a1'];
 
-	public static args = {
-		uuid: Args.string({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
 			description: 'the uuid of the device to shutdown',
+			parse: (dev) => tryAsInteger(dev),
 			required: true,
-		}),
-	};
+		},
+	];
 
-	public static flags = {
+	public static usage = 'device shutdown <uuid>';
+
+	public static flags: flags.Input<FlagsDef> = {
 		force: cf.force,
+		help: cf.help,
 	};
 
 	public static authenticated = true;
 
 	public async run() {
-		const { args: params, flags: options } =
-			await this.parse(DeviceShutdownCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceShutdownCmd,
+		);
 
 		const balena = getBalenaSdk();
 

lib/commands/devices/index.ts

@@ -0,0 +1,171 @@
+/**
+ * @license
+ * Copyright 2016-2020 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { flags } from '@oclif/command';
+import Command from '../../command';
+import * as cf from '../../utils/common-flags';
+import { expandForAppName } from '../../utils/helpers';
+import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
+import {
+	applicationIdInfo,
+	appToFleetFlagMsg,
+	appToFleetOutputMsg,
+	jsonInfo,
+	warnify,
+} from '../../utils/messages';
+import { isV13 } from '../../utils/version';
+
+import type { Application } from 'balena-sdk';
+
+interface ExtendedDevice extends DeviceWithDeviceType {
+	dashboard_url?: string;
+	application_name?: string | null;
+	device_type?: string | null;
+}
+
+interface FlagsDef {
+	application?: string;
+	app?: string;
+	fleet?: string;
+	help: void;
+	json: boolean;
+	v13: boolean;
+}
+
+export default class DevicesCmd extends Command {
+	public static description = stripIndent`
+		List all devices.
+
+		List all of your devices.
+
+		Devices can be filtered by fleet with the \`--fleet\` option.
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+
+		${jsonInfo.split('\n').join('\n\t\t')}
+	`;
+	public static examples = [
+		'$ balena devices',
+		'$ balena devices --fleet MyFleet',
+		'$ balena devices -f myorg/myfleet',
+	];
+
+	public static usage = 'devices';
+
+	public static flags: flags.Input<FlagsDef> = {
+		...(isV13()
+			? {}
+			: {
+					application: {
+						...cf.application,
+						exclusive: ['app', 'fleet', 'v13'],
+					},
+					app: { ...cf.app, exclusive: ['application', 'fleet', 'v13'] },
+			  }),
+		fleet: { ...cf.fleet, exclusive: ['app', 'application'] },
+		json: cf.json,
+		help: cf.help,
+		v13: cf.v13,
+	};
+
+	public static primary = true;
+
+	public static authenticated = true;
+
+	protected useAppWord = false;
+	protected hasWarned = false;
+
+	public async run() {
+		const { flags: options } = this.parse<FlagsDef, {}>(DevicesCmd);
+		this.useAppWord = !options.fleet && !options.v13 && !isV13();
+
+		const balena = getBalenaSdk();
+
+		if (
+			(options.application || options.app) &&
+			!options.json &&
+			process.stderr.isTTY
+		) {
+			this.hasWarned = true;
+			console.error(warnify(appToFleetFlagMsg));
+		}
+		// Consolidate application options
+		options.application ||= options.app || options.fleet;
+
+		let devices;
+
+		if (options.application != null) {
+			const { getApplication } = await import('../../utils/sdk');
+			const application = await getApplication(balena, options.application);
+			devices = (await balena.models.device.getAllByApplication(
+				application.id,
+				expandForAppName,
+			)) as ExtendedDevice[];
+		} else {
+			devices = (await balena.models.device.getAll(
+				expandForAppName,
+			)) as ExtendedDevice[];
+		}
+
+		devices = devices.map(function (device) {
+			device.dashboard_url = balena.models.device.getDashboardUrl(device.uuid);
+
+			const belongsToApplication =
+				device.belongs_to__application as Application[];
+			device.application_name = belongsToApplication?.[0]?.app_name || null;
+
+			device.uuid = options.json ? device.uuid : device.uuid.slice(0, 7);
+
+			device.device_type = device.is_of__device_type?.[0]?.slug || null;
+			return device;
+		});
+
+		const jName = this.useAppWord ? 'application_name' : 'fleet_name';
+		const tName = this.useAppWord ? 'APPLICATION NAME' : 'FLEET';
+		const fields = [
+			'id',
+			'uuid',
+			'device_name',
+			'device_type',
+			options.json
+				? `application_name => ${jName}`
+				: `application_name => ${tName}`,
+			'status',
+			'is_online',
+			'supervisor_version',
+			'os_version',
+			'dashboard_url',
+		];
+
+		if (options.json) {
+			const { pickAndRename } = await import('../../utils/helpers');
+			const mapped = devices.map((device) => pickAndRename(device, fields));
+			console.log(JSON.stringify(mapped, null, 4));
+		} else {
+			if (!this.hasWarned && this.useAppWord && process.stderr.isTTY) {
+				console.error(warnify(appToFleetOutputMsg));
+			}
+			const _ = await import('lodash');
+			console.log(
+				getVisuals().table.horizontal(
+					devices.map((dev) => _.mapValues(dev, (val) => val ?? 'N/a')),
+					fields,
+				),
+			);
+		}
+	}
+}

lib/commands/devices/supported.ts

@@ -0,0 +1,154 @@
+/**
+ * @license
+ * Copyright 2016-2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { flags } from '@oclif/command';
+import * as _ from 'lodash';
+import Command from '../../command';
+
+import * as cf from '../../utils/common-flags';
+import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
+import { CommandHelp } from '../../utils/oclif-utils';
+import { isV13 } from '../../utils/version';
+
+interface FlagsDef {
+	discontinued: boolean;
+	help: void;
+	json?: boolean;
+	verbose?: boolean;
+}
+
+const deprecatedInfo = isV13()
+	? ''
+	: `
+The --verbose option may add extra columns/fields to the output. Currently
+this includes the "STATE" column which is DEPRECATED and whose values are one
+of 'new', 'released' or 'discontinued'. However, 'discontinued' device types
+are only listed if the '--discontinued' option is also used, and this option
+is also DEPRECATED.
+`
+			.split('\n')
+			.join(`\n\t\t`);
+
+export default class DevicesSupportedCmd extends Command {
+	public static description = stripIndent`
+		List the supported device types (like 'raspberrypi3' or 'intel-nuc').
+
+		List the supported device types (like 'raspberrypi3' or 'intel-nuc').
+		${deprecatedInfo}
+		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 (for example, the ALIASES column contains a
+		list of zero or more values). The 'jq' utility may be helpful in shell scripts
+		(https://stedolan.github.io/jq/manual/).
+`;
+	public static examples = [
+		'$ balena devices supported',
+		'$ balena devices supported --verbose',
+		'$ balena devices supported -vj',
+	];
+
+	public static usage = (
+		'devices supported ' +
+		new CommandHelp({ args: DevicesSupportedCmd.args }).defaultUsage()
+	).trim();
+
+	public static flags: flags.Input<FlagsDef> = {
+		discontinued: flags.boolean({
+			description: isV13()
+				? 'No effect (DEPRECATED)'
+				: 'include "discontinued" device types (DEPRECATED)',
+		}),
+		help: cf.help,
+		json: flags.boolean({
+			char: 'j',
+			description: 'produce JSON output instead of tabular output',
+		}),
+		verbose: flags.boolean({
+			char: 'v',
+			description: isV13()
+				? 'No effect (DEPRECATED)'
+				: 'add extra columns in the tabular output (DEPRECATED)',
+		}),
+	};
+
+	public async run() {
+		const { flags: options } = this.parse<FlagsDef, {}>(DevicesSupportedCmd);
+		const [dts, configDTs] = await Promise.all([
+			getBalenaSdk().models.deviceType.getAllSupported({
+				$expand: { is_of__cpu_architecture: { $select: 'slug' } },
+				$select: ['slug', 'name'],
+			}),
+			getBalenaSdk().models.config.getDeviceTypes(),
+		]);
+		const dtsBySlug = _.keyBy(dts, (dt) => dt.slug);
+		const configDTsBySlug = _.keyBy(configDTs, (dt) => dt.slug);
+		const discontinuedDTs = isV13()
+			? []
+			: configDTs.filter((dt) => dt.state === 'DISCONTINUED');
+		const discontinuedDTsBySlug = _.keyBy(discontinuedDTs, (dt) => dt.slug);
+		// set of slugs from models.deviceType.getAllSupported() plus slugs of
+		// discontinued device types as per models.config.getDeviceTypes()
+		const slugsOfInterest = new Set([
+			...Object.keys(dtsBySlug),
+			...Object.keys(discontinuedDTsBySlug),
+		]);
+		interface DT {
+			slug: string;
+			aliases: string[];
+			arch: string;
+			state?: string; // to be removed in CLI v13
+			name: string;
+		}
+		let deviceTypes: DT[] = [];
+		for (const slug of slugsOfInterest) {
+			const configDT: Partial<typeof configDTs[0]> =
+				configDTsBySlug[slug] || {};
+			if (configDT.state === 'DISCONTINUED' && !options.discontinued) {
+				continue;
+			}
+			const dt: Partial<typeof dts[0]> = dtsBySlug[slug] || {};
+			const aliases = (configDT.aliases || []).filter(
+				(alias) => alias !== slug,
+			);
+			deviceTypes.push({
+				slug,
+				aliases: options.json ? aliases : [aliases.join(', ')],
+				arch:
+					(dt.is_of__cpu_architecture as any)?.[0]?.slug ||
+					configDT.arch ||
+					'n/a',
+				// 'BETA' renamed to 'NEW'
+				// https://www.flowdock.com/app/rulemotion/i-cli/threads/1svvyaf8FAZeSdG4dPJc4kHOvJU
+				state: isV13()
+					? undefined
+					: (configDT.state || 'NEW').replace('BETA', 'NEW'),
+				name: dt.name || configDT.name || 'N/A',
+			});
+		}
+		const fields =
+			options.verbose && !isV13()
+				? ['slug', 'aliases', 'arch', 'state', 'name']
+				: ['slug', 'aliases', 'arch', 'name'];
+		deviceTypes = _.sortBy(deviceTypes, fields);
+		if (options.json) {
+			console.log(JSON.stringify(deviceTypes, null, 4));
+		} else {
+			const visuals = getVisuals();
+			const output = await visuals.table.horizontal(deviceTypes, fields);
+			console.log(output);
+		}
+	}
+}

lib/commands/env/add.ts

@@ -15,16 +15,24 @@
  * limitations under the License.
  */
 
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
 import type * as BalenaSdk from 'balena-sdk';
+import Command from '../../command';
 import { ExpectedError } from '../../errors';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
-import { applicationIdInfo } from '../../utils/messages';
+import {
+	applicationIdInfo,
+	appToFleetFlagMsg,
+	warnify,
+} from '../../utils/messages';
+import { isV13 } from '../../utils/version';
 
 interface FlagsDef {
+	application?: string;
 	fleet?: string;
 	device?: string; // device UUID
+	help: void;
 	quiet: boolean;
 	service?: string; // service name
 }
@@ -34,14 +42,11 @@ interface ArgsDef {
 	value?: string;
 }
 
-export default class EnvSetCmd extends Command {
-	public static aliases = ['env add'];
-	public static deprecateAliases = true;
-
+export default class EnvAddCmd extends Command {
 	public static description = stripIndent`
-		Add or update env or config variable to fleets, devices or services.
+		Add env or config variable to fleets, devices or services.
 
-		Add or update an environment or config variable to one or more fleets, devices or
+		Add an environment or config variable to one or more fleets, devices or
 		services, as selected by the respective command-line options. Either the
 		--fleet or the --device option must be provided,  and either may be be
 		used alongside the --service option to define a service-specific variable.
@@ -68,52 +73,61 @@ export default class EnvSetCmd extends Command {
 	`;
 
 	public static examples = [
-		'$ balena env set TERM --fleet MyFleet',
-		'$ balena env set EDITOR vim -f myorg/myfleet',
-		'$ balena env set EDITOR vim --fleet MyFleet,MyFleet2',
-		'$ balena env set EDITOR vim --fleet MyFleet --service MyService',
-		'$ balena env set EDITOR vim --fleet MyFleet,MyFleet2 --service MyService,MyService2',
-		'$ balena env set EDITOR vim --device 7cf02a6',
-		'$ balena env set EDITOR vim --device 7cf02a6,d6f1433',
-		'$ balena env set EDITOR vim --device 7cf02a6 --service MyService',
-		'$ balena env set EDITOR vim --device 7cf02a6,d6f1433 --service MyService,MyService2',
+		'$ balena env add TERM --fleet MyFleet',
+		'$ balena env add EDITOR vim -f myorg/myfleet',
+		'$ balena env add EDITOR vim --fleet MyFleet,MyFleet2',
+		'$ balena env add EDITOR vim --fleet MyFleet --service MyService',
+		'$ balena env add EDITOR vim --fleet MyFleet,MyFleet2 --service MyService,MyService2',
+		'$ balena env add EDITOR vim --device 7cf02a6',
+		'$ balena env add EDITOR vim --device 7cf02a6,d6f1433',
+		'$ balena env add EDITOR vim --device 7cf02a6 --service MyService',
+		'$ balena env add EDITOR vim --device 7cf02a6,d6f1433 --service MyService,MyService2',
 	];
 
-	public static args = {
-		name: Args.string({
+	public static args = [
+		{
+			name: 'name',
 			required: true,
 			description: 'environment or config variable name',
-		}),
-		value: Args.string({
+		},
+		{
+			name: 'value',
 			required: false,
 			description:
 				"variable value; if omitted, use value from this process' environment",
-		}),
-	};
+		},
+	];
 
-	// Required for supporting empty string ('') `value` args.
-	public static strict = false;
+	public static usage = 'env add <name> [value]';
 
-	public static flags = {
-		fleet: { ...cf.fleet, exclusive: ['device'] },
-		device: { ...cf.device, exclusive: ['fleet'] },
+	public static flags: flags.Input<FlagsDef> = {
+		...(isV13()
+			? {}
+			: { application: { ...cf.application, exclusive: ['fleet', 'device'] } }),
+		fleet: { ...cf.fleet, exclusive: ['application', 'device'] },
+		device: { ...cf.device, exclusive: ['application', 'fleet'] },
+		help: cf.help,
 		quiet: cf.quiet,
 		service: cf.service,
 	};
 
 	public async run() {
-		const { args: params, flags: options } = await this.parse(EnvSetCmd);
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			EnvAddCmd,
+		);
 		const cmd = this;
 
-		if (!options.fleet && !options.device) {
+		if (options.application && process.stderr.isTTY) {
+			console.error(warnify(appToFleetFlagMsg));
+		}
+		options.application ||= options.fleet;
+		if (!options.application && !options.device) {
 			throw new ExpectedError(
 				'Either the --fleet or the --device option must be specified',
 			);
 		}
 
-		const { checkLoggedIn } = await import('../../utils/patterns');
-
-		await checkLoggedIn();
+		await Command.checkLoggedIn();
 
 		if (params.value == null) {
 			params.value = process.env[params.name];
@@ -149,16 +163,16 @@ export default class EnvSetCmd extends Command {
 		}
 
 		const varType = isConfigVar ? 'configVar' : 'envVar';
-		if (options.fleet) {
-			for (const appSlug of await resolveFleetSlugs(balena, options.fleet)) {
+		if (options.application) {
+			for (const app of options.application.split(',')) {
 				try {
 					await balena.models.application[varType].set(
-						appSlug,
+						app,
 						params.name,
 						params.value,
 					);
 				} catch (err) {
-					console.error(`${err.message}, fleet: ${appSlug}`);
+					console.error(`${err.message}, fleet: ${app}`);
 					process.exitCode = 1;
 				}
 			}
@@ -179,25 +193,6 @@ export default class EnvSetCmd extends Command {
 	}
 }
 
-// TODO: Stop accepting application names in the next major
-// and just drop this in favor of doing the .split(',') directly.
-async function resolveFleetSlugs(
-	balena: BalenaSdk.BalenaSDK,
-	fleetOption: string,
-) {
-	const fleetSlugs: string[] = [];
-	const { getFleetSlug } = await import('../../utils/sdk');
-	for (const appNameOrSlug of fleetOption.split(',')) {
-		try {
-			fleetSlugs.push(await getFleetSlug(balena, appNameOrSlug));
-		} catch (err) {
-			console.error(`${err.message}, fleet: ${appNameOrSlug}`);
-			process.exitCode = 1;
-		}
-	}
-	return fleetSlugs;
-}
-
 /**
  * Add service variables for a device or fleet.
  */
@@ -206,18 +201,18 @@ async function setServiceVars(
 	params: ArgsDef,
 	options: FlagsDef,
 ) {
-	if (options.fleet) {
-		for (const appSlug of await resolveFleetSlugs(sdk, options.fleet)) {
+	if (options.application) {
+		for (const app of options.application.split(',')) {
 			for (const service of options.service!.split(',')) {
 				try {
-					const serviceId = await getServiceIdForApp(sdk, appSlug, service);
+					const serviceId = await getServiceIdForApp(sdk, app, service);
 					await sdk.models.service.var.set(
 						serviceId,
 						params.name,
 						params.value!,
 					);
 				} catch (err) {
-					console.error(`${err.message}, fleet: ${appSlug}`);
+					console.error(`${err.message}, fleet: ${app}`);
 					process.exitCode = 1;
 				}
 			}
@@ -262,12 +257,11 @@ async function setServiceVars(
  */
 async function getServiceIdForApp(
 	sdk: BalenaSdk.BalenaSDK,
-	appSlug: string,
+	appName: string,
 	serviceName: string,
 ): Promise<number> {
 	let serviceId: number | undefined;
-	const services = await sdk.models.service.getAllByApplication(appSlug, {
-		$select: 'id',
+	const services = await sdk.models.service.getAllByApplication(appName, {
 		$filter: { service_name: serviceName },
 	});
 	if (services.length > 0) {
@@ -275,7 +269,7 @@ async function getServiceIdForApp(
 	}
 	if (serviceId === undefined) {
 		throw new ExpectedError(
-			`Cannot find service ${serviceName} for fleet ${appSlug}`,
+			`Cannot find service ${serviceName} for fleet ${appName}`,
 		);
 	}
 	return serviceId;

lib/commands/env/rename.ts

@@ -14,11 +14,28 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import Command from '../../command';
+
+import * as cf from '../../utils/common-flags';
 import * as ec from '../../utils/env-common';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
 import { parseAsInteger } from '../../utils/validation';
 
+type IArg<T> = import('@oclif/parser').args.IArg<T>;
+
+interface FlagsDef {
+	config: boolean;
+	device: boolean;
+	service: boolean;
+	help: void;
+}
+
+interface ArgsDef {
+	id: number;
+	value: string;
+}
+
 export default class EnvRenameCmd extends Command {
 	public static description = stripIndent`
 		Change the value of a config or env var for a fleet, device or service.
@@ -37,31 +54,36 @@ export default class EnvRenameCmd extends Command {
 		'$ balena env rename 678678 1 --device --config',
 	];
 
-	public static args = {
-		id: Args.integer({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'id',
 			required: true,
 			description: "variable's numeric database ID",
 			parse: (input) => parseAsInteger(input, 'id'),
-		}),
-		value: Args.string({
+		},
+		{
+			name: 'value',
 			required: true,
 			description:
 				"variable value; if omitted, use value from this process' environment",
-		}),
-	};
+		},
+	];
 
-	public static flags = {
+	public static usage = 'env rename <id> <value>';
+
+	public static flags: flags.Input<FlagsDef> = {
 		config: ec.booleanConfig,
 		device: ec.booleanDevice,
 		service: ec.booleanService,
+		help: cf.help,
 	};
 
 	public async run() {
-		const { args: params, flags: opt } = await this.parse(EnvRenameCmd);
+		const { args: params, flags: opt } = this.parse<FlagsDef, ArgsDef>(
+			EnvRenameCmd,
+		);
 
-		const { checkLoggedIn } = await import('../../utils/patterns');
-
-		await checkLoggedIn();
+		await Command.checkLoggedIn();
 
 		await getBalenaSdk().pine.patch({
 			resource: ec.getVarResourceName(opt.config, opt.device, opt.service),

lib/commands/env/rm.ts

@@ -15,11 +15,26 @@
  * limitations under the License.
  */
 
-import { Flags, Args, Command } from '@oclif/core';
+import { flags } from '@oclif/command';
+import Command from '../../command';
+
 import * as ec from '../../utils/env-common';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
 import { parseAsInteger } from '../../utils/validation';
 
+type IArg<T> = import('@oclif/parser').args.IArg<T>;
+
+interface FlagsDef {
+	config: boolean;
+	device: boolean;
+	service: boolean;
+	yes: boolean;
+}
+
+interface ArgsDef {
+	id: number;
+}
+
 export default class EnvRmCmd extends Command {
 	public static description = stripIndent`
 		Remove a config or env var from a fleet, device or service.
@@ -42,19 +57,22 @@ export default class EnvRmCmd extends Command {
 		'$ balena env rm 789789 --device --service --yes',
 	];
 
-	public static args = {
-		id: Args.integer({
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'id',
 			required: true,
 			description: "variable's numeric database ID",
 			parse: (input) => parseAsInteger(input, 'id'),
-		}),
-	};
+		},
+	];
 
-	public static flags = {
+	public static usage = 'env rm <id>';
+
+	public static flags: flags.Input<FlagsDef> = {
 		config: ec.booleanConfig,
 		device: ec.booleanDevice,
 		service: ec.booleanService,
-		yes: Flags.boolean({
+		yes: flags.boolean({
 			char: 'y',
 			description:
 				'do not prompt for confirmation before deleting the variable',
@@ -63,11 +81,11 @@ export default class EnvRmCmd extends Command {
 	};
 
 	public async run() {
-		const { args: params, flags: opt } = await this.parse(EnvRmCmd);
+		const { args: params, flags: opt } = this.parse<FlagsDef, ArgsDef>(
+			EnvRmCmd,
+		);
 
-		const { checkLoggedIn } = await import('../../utils/patterns');
-
-		await checkLoggedIn();
+		await Command.checkLoggedIn();
 
 		const { confirm } = await import('../../utils/patterns');
 		await confirm(

lib/commands/envs.ts

@@ -14,41 +14,54 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Flags, Command } from '@oclif/core';
-import type { Interfaces } from '@oclif/core';
+import { flags } from '@oclif/command';
 import type * as SDK from 'balena-sdk';
 import * as _ from 'lodash';
-import { ExpectedError } from '../../errors';
-import * as cf from '../../utils/common-flags';
-import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
-import { applicationIdInfo } from '../../utils/messages';
+import Command from '../command';
+import { ExpectedError } from '../errors';
+import * as cf from '../utils/common-flags';
+import { getBalenaSdk, getVisuals, stripIndent } from '../utils/lazy';
+import {
+	applicationIdInfo,
+	appToFleetFlagMsg,
+	appToFleetOutputMsg,
+	warnify,
+} from '../utils/messages';
+import { isV13 } from '../utils/version';
 
-type FlagsDef = Interfaces.InferredFlags<typeof EnvListCmd.flags>;
+interface FlagsDef {
+	application?: string;
+	fleet?: string;
+	config: boolean;
+	device?: string; // device UUID
+	json: boolean;
+	help: void;
+	service?: string; // service name
+	verbose: boolean;
+	v13: boolean;
+}
 
 interface EnvironmentVariableInfo extends SDK.EnvironmentVariableBase {
-	fleet?: string | null; // fleet slug
+	appName?: string | null; // application name
 	deviceUUID?: string; // device UUID
 	serviceName?: string; // service name
 }
 
 interface DeviceServiceEnvironmentVariableInfo
 	extends SDK.DeviceServiceEnvironmentVariable {
-	fleet?: string; // fleet slug
+	appName?: string; // application name
 	deviceUUID?: string; // device UUID
 	serviceName?: string; // service name
 }
 
 interface ServiceEnvironmentVariableInfo
 	extends SDK.ServiceEnvironmentVariable {
-	fleet?: string; // fleet slug
+	appName?: string; // application name
 	deviceUUID?: string; // device UUID
 	serviceName?: string; // service name
 }
 
-export default class EnvListCmd extends Command {
-	public static aliases = ['envs'];
-	public static deprecateAliases = true;
-
+export default class EnvsCmd extends Command {
 	public static description = stripIndent`
 		List the environment or config variables of a fleet, device or service.
 
@@ -83,58 +96,80 @@ export default class EnvListCmd extends Command {
 		in case the current user was removed from the fleet by the fleet's owner).
 
 		${applicationIdInfo.split('\n').join('\n\t\t')}
+
+		${appToFleetOutputMsg.split('\n').join('\n\t\t')}
 	`;
 
 	public static examples = [
-		'$ balena env list --fleet myorg/myfleet',
-		'$ balena env list --fleet MyFleet --json',
-		'$ balena env list --fleet MyFleet --service MyService',
-		'$ balena env list --fleet MyFleet --config',
-		'$ balena env list --device 7cf02a6',
-		'$ balena env list --device 7cf02a6 --json',
-		'$ balena env list --device 7cf02a6 --config --json',
-		'$ balena env list --device 7cf02a6 --service MyService',
+		'$ balena envs --fleet myorg/myfleet',
+		'$ balena envs --fleet MyFleet --json',
+		'$ balena envs --fleet MyFleet --service MyService',
+		'$ 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',
 	];
 
-	public static flags = {
-		fleet: { ...cf.fleet, exclusive: ['device'] },
-		config: Flags.boolean({
+	public static usage = 'envs';
+
+	public static flags: flags.Input<FlagsDef> = {
+		...(isV13()
+			? {}
+			: {
+					all: flags.boolean({
+						default: false,
+						description: 'No-op since balena CLI v12.0.0.',
+						hidden: true,
+					}),
+					application: {
+						exclusive: ['device', 'fleet', 'v13'],
+						...cf.application,
+					},
+			  }),
+		fleet: { exclusive: ['device', 'application'], ...cf.fleet },
+		config: flags.boolean({
 			default: false,
 			char: 'c',
 			description: 'show configuration variables only',
 			exclusive: ['service'],
 		}),
-		device: { ...cf.device, exclusive: ['fleet'] },
+		device: { exclusive: ['fleet', 'application'], ...cf.device },
+		help: cf.help,
 		json: cf.json,
-		service: { ...cf.service, exclusive: ['config'] },
+		verbose: cf.verbose,
+		service: { exclusive: ['config'], ...cf.service },
+		v13: cf.v13,
 	};
 
+	protected useAppWord = false;
+	protected hasWarned = false;
+
 	public async run() {
-		const { flags: options } = await this.parse(EnvListCmd);
+		const { flags: options } = this.parse<FlagsDef, {}>(EnvsCmd);
+		this.useAppWord = !options.fleet && !options.v13 && !isV13();
 
 		const variables: EnvironmentVariableInfo[] = [];
 
-		const { checkLoggedIn } = await import('../../utils/patterns');
+		await Command.checkLoggedIn();
 
-		await checkLoggedIn();
-
-		if (!options.fleet && !options.device) {
+		if (options.application && !options.json && process.stderr.isTTY) {
+			this.hasWarned = true;
+			console.error(warnify(appToFleetFlagMsg));
+		}
+		options.application ||= options.fleet;
+		if (!options.application && !options.device) {
 			throw new ExpectedError('Missing --fleet or --device option');
 		}
 
 		const balena = getBalenaSdk();
 
-		let fleetSlug: string | undefined = options.fleet
-			? await (
-					await import('../../utils/sdk')
-				).getFleetSlug(balena, options.fleet)
-			: undefined;
+		let appNameOrSlug = options.application;
 		let fullUUID: string | undefined; // as oppposed to the short, 7-char UUID
 
 		if (options.device) {
-			const { getDeviceAndMaybeAppFromUUID } = await import(
-				'../../utils/cloud'
-			);
+			const { getDeviceAndMaybeAppFromUUID } = await import('../utils/cloud');
 			const [device, app] = await getDeviceAndMaybeAppFromUUID(
 				balena,
 				options.device,
@@ -143,23 +178,23 @@ export default class EnvListCmd extends Command {
 			);
 			fullUUID = device.uuid;
 			if (app) {
-				fleetSlug = app.slug;
+				appNameOrSlug = app.slug;
 			}
 		}
-		if (fleetSlug && options.service) {
-			await validateServiceName(balena, options.service, fleetSlug);
+		if (appNameOrSlug && options.service) {
+			await validateServiceName(balena, options.service, appNameOrSlug);
 		}
-		variables.push(...(await getAppVars(balena, fleetSlug, options)));
+		variables.push(...(await getAppVars(balena, appNameOrSlug, options)));
 		if (fullUUID) {
 			variables.push(
-				...(await getDeviceVars(balena, fullUUID, fleetSlug, options)),
+				...(await getDeviceVars(balena, fullUUID, appNameOrSlug, options)),
 			);
 		}
 		if (!options.json && variables.length === 0) {
 			const target =
 				(options.service ? `service "${options.service}" of ` : '') +
-				(options.fleet
-					? `fleet "${options.fleet}"`
+				(options.application
+					? `fleet "${options.application}"`
 					: `device "${options.device}"`);
 			throw new ExpectedError(`No environment variables found for ${target}`);
 		}
@@ -171,14 +206,24 @@ export default class EnvListCmd extends Command {
 		varArray: EnvironmentVariableInfo[],
 		options: FlagsDef,
 	) {
-		const fields = ['id', 'name', 'value', 'fleet'];
+		const fields = ['id', 'name', 'value'];
 
 		// Replace undefined app names with 'N/A' or null
 		varArray = varArray.map((i: EnvironmentVariableInfo) => {
-			i.fleet ||= options.json ? null : 'N/A';
+			if (i.appName) {
+				// use slug in v13, app name in v12 for compatibility
+				i.appName = isV13()
+					? i.appName
+					: i.appName.substring(i.appName.indexOf('/') + 1);
+			} else {
+				i.appName = options.json ? null : 'N/A';
+			}
 			return i;
 		});
 
+		const jName = this.useAppWord ? 'appName' : 'fleetName';
+		const tName = this.useAppWord ? 'APPLICATION' : 'FLEET';
+		fields.push(options.json ? `appName => ${jName}` : `appName => ${tName}`);
 		if (options.device) {
 			fields.push(options.json ? 'deviceUUID' : 'deviceUUID => DEVICE');
 		}
@@ -187,10 +232,13 @@ export default class EnvListCmd extends Command {
 		}
 
 		if (options.json) {
-			const { pickAndRename } = await import('../../utils/helpers');
+			const { pickAndRename } = await import('../utils/helpers');
 			const mapped = varArray.map((o) => pickAndRename(o, fields));
 			this.log(JSON.stringify(mapped, null, 4));
 		} else {
+			if (!this.hasWarned && this.useAppWord && process.stderr.isTTY) {
+				console.error(warnify(appToFleetOutputMsg));
+			}
 			this.log(
 				getVisuals().table.horizontal(
 					_.sortBy(varArray, (v: SDK.EnvironmentVariableBase) => v.name),
@@ -204,15 +252,14 @@ export default class EnvListCmd extends Command {
 async function validateServiceName(
 	sdk: SDK.BalenaSDK,
 	serviceName: string,
-	fleetSlug: string,
+	appName: string,
 ) {
-	const services = await sdk.models.service.getAllByApplication(fleetSlug, {
-		$select: 'id',
+	const services = await sdk.models.service.getAllByApplication(appName, {
 		$filter: { service_name: serviceName },
 	});
 	if (services.length === 0) {
 		throw new ExpectedError(
-			`Service "${serviceName}" not found for fleet "${fleetSlug}"`,
+			`Service "${serviceName}" not found for fleet "${appName}"`,
 		);
 	}
 }
@@ -226,18 +273,17 @@ async function validateServiceName(
  */
 async function getAppVars(
 	sdk: SDK.BalenaSDK,
-	fleetSlug: string | undefined,
+	appNameOrSlug: string | undefined,
 	options: FlagsDef,
 ): Promise<EnvironmentVariableInfo[]> {
 	const appVars: EnvironmentVariableInfo[] = [];
-	if (!fleetSlug) {
+	if (!appNameOrSlug) {
 		return appVars;
 	}
-	const vars =
-		await sdk.models.application[
-			options.config ? 'configVar' : 'envVar'
-		].getAllByApplication(fleetSlug);
-	fillInInfoFields(vars, fleetSlug);
+	const vars = await sdk.models.application[
+		options.config ? 'configVar' : 'envVar'
+	].getAllByApplication(appNameOrSlug);
+	fillInInfoFields(vars, appNameOrSlug);
 	appVars.push(...vars);
 	if (!options.config) {
 		const pineOpts: SDK.PineOptions<SDK.ServiceEnvironmentVariable> = {
@@ -253,10 +299,10 @@ async function getAppVars(
 			};
 		}
 		const serviceVars = await sdk.models.service.var.getAllByApplication(
-			fleetSlug,
+			appNameOrSlug,
 			pineOpts,
 		);
-		fillInInfoFields(serviceVars, fleetSlug);
+		fillInInfoFields(serviceVars, appNameOrSlug);
 		appVars.push(...serviceVars);
 	}
 	return appVars;
@@ -269,15 +315,16 @@ async function getAppVars(
 async function getDeviceVars(
 	sdk: SDK.BalenaSDK,
 	fullUUID: string,
-	fleetSlug: string | undefined,
+	appNameOrSlug: string | undefined,
 	options: FlagsDef,
 ): Promise<EnvironmentVariableInfo[]> {
 	const printedUUID = options.json ? fullUUID : options.device!;
 	const deviceVars: EnvironmentVariableInfo[] = [];
 	if (options.config) {
-		const deviceConfigVars =
-			await sdk.models.device.configVar.getAllByDevice(fullUUID);
-		fillInInfoFields(deviceConfigVars, fleetSlug, printedUUID);
+		const deviceConfigVars = await sdk.models.device.configVar.getAllByDevice(
+			fullUUID,
+		);
+		fillInInfoFields(deviceConfigVars, appNameOrSlug, printedUUID);
 		deviceVars.push(...deviceConfigVars);
 	} else {
 		const pineOpts: SDK.PineOptions<SDK.DeviceServiceEnvironmentVariable> = {
@@ -298,12 +345,13 @@ async function getDeviceVars(
 			fullUUID,
 			pineOpts,
 		);
-		fillInInfoFields(deviceServiceVars, fleetSlug, printedUUID);
+		fillInInfoFields(deviceServiceVars, appNameOrSlug, printedUUID);
 		deviceVars.push(...deviceServiceVars);
 
-		const deviceEnvVars =
-			await sdk.models.device.envVar.getAllByDevice(fullUUID);
-		fillInInfoFields(deviceEnvVars, fleetSlug, printedUUID);
+		const deviceEnvVars = await sdk.models.device.envVar.getAllByDevice(
+			fullUUID,
+		);
+		fillInInfoFields(deviceEnvVars, appNameOrSlug, printedUUID);
 		deviceVars.push(...deviceEnvVars);
 	}
 	return deviceVars;
@@ -319,7 +367,7 @@ function fillInInfoFields(
 		| EnvironmentVariableInfo[]
 		| DeviceServiceEnvironmentVariableInfo[]
 		| ServiceEnvironmentVariableInfo[],
-	fleetSlug?: string,
+	appNameOrSlug?: string,
 	deviceUUID?: string,
 ) {
 	for (const envVar of varArray) {
@@ -333,7 +381,7 @@ function fillInInfoFields(
 					?.installs__service as SDK.Service[]
 			)[0]?.service_name;
 		}
-		envVar.fleet = fleetSlug;
+		envVar.appName = appNameOrSlug;
 		envVar.serviceName = envVar.serviceName || '*';
 		envVar.deviceUUID = deviceUUID || '*';
 	}

lib/commands/fleet/create.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FleetCreateCmd } from '../app/create';
+
+export default FleetCreateCmd;

lib/commands/fleet/index.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FleetCmd } from '../app';
+
+export default FleetCmd;

lib/commands/fleet/purge.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FleetPurgeCmd } from '../app/purge';
+
+export default FleetPurgeCmd;

lib/commands/fleet/rename.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FleetRenameCmd } from '../app/rename';
+
+export default FleetRenameCmd;

lib/commands/fleet/restart.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FleetRestartCmd } from '../app/restart';
+
+export default FleetRestartCmd;

lib/commands/fleet/rm.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FleetRmCmd } from '../app/rm';
+
+export default FleetRmCmd;

lib/commands/fleets.ts

@@ -0,0 +1,20 @@
+/**
+ * @license
+ * Copyright 2016-2021 Balena Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { FleetsCmd } from './apps';
+
+export default FleetsCmd;