WIP

patch: Tell user that balena leave command does not remove the device…

.dockerignore

@@ -0,0 +1,37 @@
+# Reminders:
+# * Matching rules are different to `.gitignore`
+# * A pattern without '**' matches in the project's root directory only
+# * Leading and trailing '/' are discarded (it is not possible to
+#   distinguish between files and directories)
+# * More details: https://github.com/balena-io-modules/dockerignore
+
+# development and testing tools or IDEs
+**/*.log
+**/*.pid
+**/*.seed
+.idea
+.lock-wscript
+.nvmrc
+.nyc_output
+.vscode
+coverage
+lib-cov
+logs
+pids
+
+# OS cache files
+**/.DS_Store
+
+# balena CLI config and build files
+**/.balenaconf
+**/.fast-boot.json
+**/.resinconf
+balenarc.yml
+build
+build-bin
+dist
+node_modules
+oclif.manifest.json
+package-lock.json
+resinrc.yml
+tmp

.gitattributes

@@ -6,7 +6,7 @@
 *.sh text eol=lf
 
 # lf for the docs as it's auto-generated and will otherwise trigger an uncommited error on windows
-doc/cli.markdown text eol=lf
+docs/balena-cli.md 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/CODEOWNERS

@@ -1 +0,0 @@
-* @balena-io/balena-cli

.github/ISSUE_TEMPLATE.md

@@ -11,8 +11,8 @@ community can both contribute and benefit from the answers.*
 *Please also check that this issue is not a duplicate. If there is another issue describing
 the same problem or feature please add comments to the existing issue.*
 
-*Thank you for your time and effort creating the issue report, and helping us improve the
-balena CLI!*
+*Thank you for your time and effort creating the issue report, and helping us improve
+the balena CLI!*
 
 ---
 
@@ -32,11 +32,11 @@ Please describe what actually happened instead:
   Examples:
 
 ```
-balena push myApp
+balena push myFleet
 balena push 192.168.0.12
-balena deploy myApp
-balena deploy myApp --build
-balena build . -a myApp
+balena deploy myFleet
+balena deploy myFleet --build
+balena build . -f myFleet
 balena build . -A armv7hf -d raspberrypi3
 ```
 
@@ -48,7 +48,7 @@ additional information. The `--logs` option reveals additional information for t
 
 ```
 balena build . --logs
-balena deploy myApp --build --logs
+balena deploy myFleet --build --logs
 ```
 
 # Steps to Reproduce the Problem

.gitignore

@@ -1,47 +1,36 @@
-# Logs
-logs
-*.log
+# Reminders:
+# * A pattern without '/' matches in subdirectories as well (files and directories)
+# * A leading '/' anchors matching to the directory where `.gitignore` is defined
+# * A trailing '/' makes the pattern match against directories only
+# More details: https://git-scm.com/docs/gitignore
 
-# Runtime data
-pids
+# development and testing tools or IDEs
+*.log
 *.pid
 *.seed
+/.idea/
+/.lock-wscript
+/.nvmrc
+/.nyc_output/
+/.vscode/
+/coverage/
+/lib-cov/
+/logs
+/pids
 
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-.nyc_output
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# Commenting this out is preferred by some people, see
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
-node_modules
-
-package-lock.json
-.resinconf
-.balenaconf
-resinrc.yml
-balenarc.yml
-
+# OS cache files
 .DS_Store
-.idea
-.nvmrc
-.vscode
 
-/tmp
-build/
-build-bin/
-build-zip/
-dist/
-
-# Ignore fast-boot cache file
-**/.fast-boot.json
+# balena CLI config and build files
+.balenaconf
+.fast-boot.json
+.resinconf
+/balenarc.yml
+/build/
+/build-bin/
+/dist/
+/node_modules
 /oclif.manifest.json
+/package-lock.json
+/resinrc.yml
+/tmp/

.mocharc-standalone.js

@@ -0,0 +1,6 @@
+const commonConfig = require('./.mocharc.js');
+
+module.exports = {
+	...commonConfig,
+	spec: ['tests/auth/*.spec.ts', 'tests/commands/**/*.spec.ts'],
+};

.mocharc.js

@@ -0,0 +1,10 @@
+module.exports = {
+	reporter: 'spec',
+	require: 'ts-node/register/transpile-only',
+	file: './tests/config-tests',
+	timeout: 12000,
+	// 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'],
+	spec: 'tests/**/*.spec.ts',
+};

.resinci.yml

@@ -5,16 +5,16 @@ npm:
       os: ubuntu
       architecture: x86_64
       node_versions:
-        - "10"
         - "12"
         - "14"
-    - name: linux
-      os: alpine
-      architecture: x86_64
-      node_versions:
-        - "10"
-        - "12"
-        - "14"
-
-docker:
-  publish: false
+    ##
+    ## Temporarily skip Alpine tests until the following issues are resolved:
+    ##   * https://github.com/concourse/concourse/issues/7905
+    ##   * https://github.com/product-os/balena-concourse/issues/631
+    ##
+    # - name: linux
+    #   os: alpine
+    #   architecture: x86_64
+    #   node_versions:
+    #     - "12"
+    #     - "14"

.travis.yml

@@ -1,25 +0,0 @@
-language: node_js
-os:
-  - linux
-  - osx
-node_js:
-  - "10"
-matrix:
-  exclude:
-    node_js: "10"
-script:
-  - node --version
-  - npm --version
-  - npm run ci
-  # - npm run build:standalone
-  # - npm run build:installer
-notifications:
-  email: false
-deploy:
-  - provider: script
-    script: npm run release
-    skip_cleanup: true
-    on:
-      tags: true
-      condition: "$TRAVIS_TAG =~ ^v?[[:digit:]]+\\.[[:digit:]]+\\.[[:digit:]]+"
-      repo: balena-io/balena-cli

CONTRIBUTING.md

@@ -2,10 +2,12 @@
 
 The balena CLI is an open source project and your contribution is welcome!
 
-* Install the dependencies listed in the [NPM Installation](./INSTALL.md#npm-installation)
-  section of the `INSTALL.md` file. Check the section [Additional
-  Dependencies](./INSTALL.md#additional-dependencies) too.
-* Clone the `balena-cli` repository, `cd` to it and run `npm install`.
+* Install the dependencies listed in the [NPM Installation
+  section](./INSTALL-ADVANCED.md#npm-installation) section of the installation instructions. Check
+  the section [Additional Dependencies](./INSTALL-ADVANCED.md#additional-dependencies) too.
+* Clone the `balena-cli` repository (or a [forked
+  repo](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo),
+  if you are not in the balena team), `cd` to it and run `npm install`.
 * Build the CLI with `npm run build` or `npm test`, and execute it with `./bin/balena`
   (on a Windows command prompt, you may need to run `node .\bin\balena`).
 
@@ -19,99 +21,203 @@ Before opening a PR, test your changes with `npm test`. Keep compatibility in mi
 meant to run on Linux, macOS and Windows. balena CI will run test code on all three platforms, but
 this will only help if you add some test cases for your new code!
 
-## ./bin/balena-dev and oclif
+## Semantic versioning, commit messages and the ChangeLog
 
-When using `./bin/balena-dev` with oclif-converted commands, it is currently necessary to manually
-edit the `oclif` section of `package.json` to replace `./build` with `./lib` as follows:
+When a pull request is merged, Balena's versionbot / Continuous Integration system takes care of
+automatically creating a new CLI release on both the [npm
+registry](https://www.npmjs.com/package/balena-cli) and the GitHub [releases
+page](https://github.com/balena-io/balena-cli/releases). The release version numbering adheres to
+the [Semantic Versioning's](http://semver.org/) concept of patch, minor and major releases.
+Generally, bug fixes and documentation changes are classed as patch changes, while new features are
+classed as minor changes. If a change breaks backwards compatibility, it is a major change.
 
-Change from:
-```
-  "oclif": {
-    "commands": "./build/actions-oclif",
-    "hooks": {
-      "prerun": "./build/hooks/prerun/track"
-```
+A new version entry is also automatically added to the
+[CHANGELOG.md](https://github.com/balena-io/balena-cli/blob/master/CHANGELOG.md) file when a pull
+request is merged. Each pull request corresponds to a single version / release. Each commit in the
+pull request becomes a bullet point entry in the Changelog. The Changelog file should not be
+manually edited.
 
-To:
-```
-  "oclif": {
-    "commands": "./lib/actions-oclif",
-    "hooks": {
-      "prerun": "./lib/hooks/prerun/track"
-```
+To support this automation, a commit message should be structured as follows:
 
-And then remember to change it back before pushing the pull request. This is obviously error prone
-and inconvenient, and improvement suggestions are welcome: is there a better solution than
-automatically editing `package.json`? It is doable, if it is what needs to be done.
+```text
+The first line becomes a bullet point in the CHANGELOG file
 
-## Semantic versioning and commit messages
+Optionally, a more detailed description in one or more paragraphs.
+The detailed description can be seen with `git log`, but it is not copied
+to the CHANGELOG file.
 
-The CLI version numbering adheres to [Semantic Versioning](http://semver.org/). The following
-header/row is required in the body of a commit message, and will cause the CI build to fail if absent:
-
-```
 Change-type: patch|minor|major
 ```
 
-Version numbers and commit messages are automatically added to the `CHANGELOG.md` file by the CI
-build flow, after a pull request is merged. It should not be manually edited.
+Only the first line of the commit message is copied to the Changelog file. The `Change-type` footer
+must be preceded by a blank line, and indicates the commit's semver change type. When a PR consists
+of multiple commits, the commits may have different change type values. As a whole, the PR will
+produce a release of the "highest" change type. For example, two commits mixing patch and minor
+change types will produce a minor CLI release, while two commits mixing minor and major change
+types will produce a major CLI release.
 
-## Editing documentation files (CHANGELOG, README, website...)
+The commit message is parsed / checked by versionbot with the
+[resin-commit-lint](https://github.com/balena-io-modules/resin-commit-lint#resin-commit-lint)
+package.
 
-The `doc/cli.markdown` file is automatically generated by running `npm run build:doc` (which also
+Because of the way that the Changelog file is automatically updated from commit messages, which
+become the source of "what's new" for CLI end users, we advocate "meaningful commits" and
+user-focused commit messages. A meaningful commit is one that, in isolation, introduces a fix or
+feature (or part of a fix or feature) that makes sense at the Changelog level, and which leaves the
+CLI in a non-broken state. Sometimes, in the course of preparing a single pull request, a developer
+creates several commits as a way of saving their "work in progress", which may even fail to build
+(e.g. `npm run build` fails), and which is then fixed or undone by further commits in the same PR.
+In this situation, the recommendation is to "squash" or "fixup" the work-in-progress commits into
+fewer, meaningful commits. Interactive rebase is a good tool to achieve this:
+[blog](https://thoughtbot.com/blog/git-interactive-rebase-squash-amend-rewriting-history),
+[docs](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History).
+
+Mixing multiple distinct features or bug fixes in a single commit is discouraged, because the
+description will likely not fit in the single-line Changelog bullet point and also because it
+makes it harder to review the pull request (especially a large one) and harder to isolate and
+revert individual changes in case a bug is found later on. Create a separate commit for each
+feature / bug fix, or even separate pull requests.
+
+If you need to catch up with changes to the master branch while working on a pull request,
+use rebase instead of merge: [docs](https://git-scm.com/book/en/v2/Git-Branching-Rebasing).
+
+If `package.json` is updated for dependencies listed in the `repo.yml` file (like `balena-sdk`),
+the commit message body should also include a line in the following format:
+```
+Update balena-sdk from 12.0.0 to 12.1.0
+```
+
+This allows versionbot to produce nested Changelog entries (with expandable arrows), pulling in
+commit messages from the upstream repositories. The following npm script can be used to
+automatically produce a commit with a suitable commit message:
+```
+npm run update balena-sdk ^12.1.0
+```
+
+The script will create a new branch (only if `master` is currently checked out), run `npm update`
+with the given target version and commit the `package.json` and `npm-shrinkwrap.json` files. The
+script by default will set the `Change-type` to `patch` or `minor`, depending on the semver change
+of the updated dependency. A `major` change type can specified as an extra argument:
+```
+npm run update balena-sdk ^12.14.0 patch
+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
 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 `doc/cli.markdown` are:
+The content sources for the auto generation of `docs/balena-cli.md` are:
 
-* Selected sections of the README file.
-* The CLI's command documentation in source code (both Capitano and oclif commands), for example:
-  * `lib/actions/build.coffee`
-  * `lib/actions-oclif/env/add.ts`
+* [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 (`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
-`doc/cli.markdown` by the `getCapitanoDoc()` function in
+`docs/balena-cli.md` by the `getCapitanoDoc()` function in
 [`automation/capitanodoc/capitanodoc.ts`](https://github.com/balena-io/balena-cli/blob/master/automation/capitanodoc/capitanodoc.ts).
 
-The `INSTALL.md` and `TROUBLESHOOTING.md` files are also manually edited.
+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
 
-Please note that `npm run build:installer` (which generates the `.exe` executable installer on
-Windows) specifically requires [MSYS2](https://www.msys2.org/) to be installed. Other than that,
-the standard Command Prompt or PowerShell can be used (though MSYS2 is still handy, as it provides
-'git' and a number of common unix utilities). If you make changes to `package.json` scripts, check
-they also run on a standard Windows Command Prompt.
+Besides the regular npm installation dependencies, the `npm run build:installer` script
+that produces the `.exe` graphical installer on Windows also requires
+[NSIS](https://sourceforge.net/projects/nsis/) and [MSYS2](https://www.msys2.org/) to be
+installed. Be sure to add `C:\Program Files (x86)\NSIS` to the PATH, so that `makensis`
+is available. MSYS2 is recommended when developing the balena CLI on Windows.
+
+If changes are made to npm scripts in `package.json`, don't assume that a Unix shell like
+bash is available. For example, some Windows shells don't have the `cp` and `rm` commands,
+which is why you'll often find `ncp` and `rimraf` used in `package.json` scripts.
 
 ## Updating the 'npm-shrinkwrap.json' file
 
 The `npm-shrinkwrap.json` file is used to control package dependencies, as documented at
 https://docs.npmjs.com/files/shrinkwrap.json.
 
-While developing, the `package.json` file is often modified by, or before, running `npm install`
-in order to add, remove or modify dependencies. When `npm install` is executed, it automatically
-updates the `npm-shrinkwrap.json` file as well, **taking into account not only the `package.json`
-file but also the current state of the `node_modules` folder in your computer.**
+Changes to `npm-shrinkwrap.json` can be automatically merged by git during operations like
+`rebase`, `pull` and `cherry-pick`, but in some cases this results in suboptimal dependency
+resolution (the `node_modules` folder may end up larger than necessary, with consequences to CLI
+load time too). For this reason, the recommended way to update `npm-shrinkwrap.json` is to run
+`npm install`, possibly alongside `npm dedupe` as well. The following commands can be used to
+fix shrinkwrap issues and optimize the dependencies:
 
-Meanwhile, as a text (JSON) file, `git` is capable of merging the `npm-shrinkwrap.json` file during
-operations like `rebase`, `cherry-pick` and `pull`. But git's automated merge is not the
-recommended way of updating the `npm-shrinkwrap.json` file, because it does not take into account
-duplicates or conflicts in the dependency tree, or indeed the state of the `package.json` file
-(which may have just been merged). You can improve this by installing the npm merge driver with:
+```sh
+git checkout master -- npm-shrinkwrap.json
+rm -rf node_modules
+npm install  # update npm-shrinkwrap.json to satisfy changes to package.json
+npm dedupe   # deduplicate dependencies from npm-shrinkwrap.json
+npm install  # re-add optional dependencies removed by dedupe
+git add npm-shrinkwrap.json  # add it for committing (solve merge errors)
 ```
+
+Note that `npm dedupe` should always be followed by `npm install`, as shown above, even if
+`npm install` had already been executed before `npm dedupe`.
+
+Optionally, these steps may be automated by installing the
+[npm-merge-driver](https://www.npmjs.com/package/npm-merge-driver):
+
+```sh
 npx npm-merge-driver install -g
 ```
 
-Whether or not there is a merge error, the following commands are the recommended way of updating
-and committing the `npm-shrinkwrap.json` file:
+## `fast-boot` and `npm link` - modifying the `node_modules` folder
 
-```bash
-$ npm install  # fetch the latest modules update the npm-shrinkwrap.json file
-$ npm dedupe  # deduplicate dependencies from the npm-shrinkwrap.json file
-$ npm install  # re-add optional dependencies for other platforms that may have been removed by dedupe
-$ git add npm-shrinkwrap.json  # add it for committing (solve merge errors)
-```
+During development or debugging, it is sometimes useful to temporarily modify the `node_modules`
+folder (with or without making the respective changes to the `npm-shrinkwrap.json` file),
+replacing dependencies with different versions. This can be achieved with the `npm link`
+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 `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:
+
+* Manually delete the module cache file (typically `~/.balena/cli-module-cache.json`), or
+* Use the `bin/balena-dev` entry point (instead of `bin/balena`) as it does not activate
+  `fast-boot2`.
 
 ## TypeScript and oclif
 
@@ -119,18 +225,12 @@ The CLI currently contains a mix of plain JavaScript and
 [TypeScript](https://www.typescriptlang.org/) code. The goal is to have all code written in
 Typescript, in order to take advantage of static typing and formal programming interfaces.
 The migration towards Typescript is taking place gradually, as part of maintenance work or
-the implementation of new features. Historically, the CLI was originally written in
-[CoffeeScript](https://coffeescript.org), but all CoffeeScript code was migrated to either
-Javascript or Typescript.
+the implementation of new features.
 
-Similarly, [Capitano](https://github.com/balena-io/capitano) was originally adopted as the CLI's
-framework, but later we decided to take advantage of [oclif](https://oclif.io/)'s features such
-as native installers for Windows, macOS and Linux, and support for custom flag parsing (for
-example, we're still battling with Capitano's behavior of dropping leading zeros of arguments that
-look like integers, such as some abbreviated UUIDs). Again, the migration is taking place
-gradually, with some CLI commands parsed by oclif and others by Capitano. A simple command line
-pre-parsing takes place in `preparser.ts`, to decide whether to route full parsing to Capitano or
-to oclif.
+Of historical interest, the CLI was originally written in [CoffeeScript](https://coffeescript.org)
+and used the [Capitano](https://github.com/balena-io/capitano) framework. All CoffeeScript code was
+migrated to either Javascript or Typescript, and Capitano was replaced with oclif. A few file or
+variable names still refer to this legacy, for example `automation/capitanodoc/capitanodoc.ts`.
 
 ## Programming style
 
@@ -138,29 +238,6 @@ to oclif.
 reformats the code. Beyond that, we have a preference for Javascript promises over callbacks, and for
 `async/await` over `.then()`.
 
-## Updating upstream dependencies
-
-In order to get proper nested changelogs, when updating upstream modules that are in the repo.yml
-(like the balena-sdk), the commit body has to contain a line with the following format:
-```
-Update balena-sdk from 12.0.0 to 12.1.0
-```
-
-Since this is error prone, it's suggested to use the following npm script:
-```
-npm run update balena-sdk ^12.1.0
-```
-
-This will create a new branch (only if you are currently on master), run `npm update` with the
-version you provided as a target and commit the package.json & npm-shrinkwrap.json. The script by
-default will set the `Change-type` to `patch` or `minor`, depending on the semver change of the
-updated dependency, but if you need to use a different one (eg `major`) you can specify it as an
-extra argument:
-```
-npm run update balena-sdk ^12.14.0 patch
-npm run update balena-sdk ^13.0.0 major
-```
-
 ## Common gotchas
 
 One thing that most CLI bugs have in common is the absence of test cases exercising the broken
@@ -215,3 +292,11 @@ gotchas to bear in mind:
   `node_modules/balena-sdk/node_modules/balena-errors`  
   In the case of subclasses of `TypedError`, a string comparison may be used instead:  
   `error.name === 'BalenaApplicationNotFound'`
+
+## Further debugging notes
+
+* If you need to selectively run specific tests, `it.only` will not work in cases when authorization is required as part of the test cycle.  In order to target specific tests, control execution via `.mocharc.js` instead.  Here is an example of targeting the `deploy` tests.
+
+	replace: `spec: 'tests/**/*.spec.ts',`
+
+	with: `spec: ['tests/auth/*.spec.ts', 'tests/**/deploy.spec.ts'],`

INSTALL-ADVANCED.md

@@ -0,0 +1,169 @@
+# balena CLI Advanced Installation Options
+
+**These are alternative, advanced installation options. Most users would prefer the [recommended,
+streamlined installation
+instructions](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md).**
+
+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 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.
+
+Some specific CLI commands have a few extra installation steps: see section [Additional
+Dependencies](#additional-dependencies).
+
+## Executable Installer
+
+This is the recommended installation option on macOS and Windows. Follow the specific OS
+instructions:
+
+* [Windows](./INSTALL-WINDOWS.md)
+* [macOS](./INSTALL-MAC.md)
+
+> Note regarding WSL ([Windows Subsystem for
+> Linux](https://docs.microsoft.com/en-us/windows/wsl/about))  
+> 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 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 Zip Package](#standalone-zip-package) instructions
+for how to modify the PATH variable.
+
+By default, the CLI is installed to the following folders:
+
+OS  | Folders
+--- | ---
+Windows: | `C:\Program Files\balena-cli\`
+macOS:   | `/usr/local/lib/balena-cli/` <br> `/usr/local/bin/balena`
+
+## Standalone Zip Package
+
+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.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 zip file contents to any folder you choose. The extracted contents will include a
+   `balena-cli` folder.
+
+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) |
+   [Windows](https://www.computerhope.com/issues/ch000549.htm)
+
+> * 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 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` 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-cli` folder.
+
+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.
+
+## NPM Installation
+
+If you are a Node.js developer, you may wish to install the balena CLI via [npm](https://www.npmjs.com).
+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 12 (min 12.8.0).**  
+> **Versions 13 and later are not yet fully supported.**
+
+### Install development tools
+
+#### **Linux or WSL** (Windows Subsystem for Linux)
+
+```sh
+$ 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 12
+```
+
+The `curl` command line above uses
+[nvm](https://github.com/nvm-sh/nvm/blob/master/README.md#install--update-script) to install
+Node.js, instead of using `apt-get`. Installing Node.js through `apt-get` is a common source of
+problems from permission errors to conflict with other system packages, and therefore not
+recommended.
+
+#### **macOS**
+
+* Download and install Apple's Command Line Tools from https://developer.apple.com/downloads/
+* Install Node.js through [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md#install--update-script):
+
+```sh
+$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
+$ . ~/.bashrc
+$ 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
+    [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:
+  * `pacman -S git gcc make openssh p7zip`
+  * [Set a Windows environment variable](https://www.onmsft.com/how-to/how-to-set-an-environment-variable-in-windows-10): `MSYS2_PATH_TYPE=inherit`
+  * Note that a bug in the MSYS2 launch script (`msys2_shell.cmd`) makes text-based
+    interactive CLI menus to misbehave. [Check this Github issue for a
+    workaround](https://github.com/msys2/MINGW-packages/issues/1633#issuecomment-240583890).
+* The Windows Driver Kit (WDK), which is needed to compile some native Node modules. It is **not**
+  necessary to install Visual Studio, only the WDK, which is "step 2" in the following guides:
+  * [WDK for Windows 10](https://docs.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk#download-icon-step-2-install-refreshed-wdk-for-windows-10-version-2004)
+  * [WDK for earlier versions of Windows](https://docs.microsoft.com/en-us/windows-hardware/drivers/other-wdk-downloads#step-2-install-the-wdk)
+* The [windows-build-tools](https://www.npmjs.com/package/windows-build-tools) npm package,
+  by running the following command on an [administrator
+  console](https://www.howtogeek.com/194041/how-to-open-the-command-prompt-as-administrator-in-windows-8.1/):  
+  `npm install --global --production windows-build-tools`
+
+### Install the balena CLI
+
+After installing the development tools, install the balena CLI with:
+
+```sh
+$ npm install balena-cli --global --production --unsafe-perm
+```
+
+`--unsafe-perm` is needed when `npm install` is executed as the `root` user (e.g. in a Docker
+container) in order to allow npm scripts like `postinstall` to be executed.
+
+## Additional Dependencies
+
+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:
+
+* [Windows](./INSTALL-WINDOWS.md#additional-dependencies)
+* [macOS](./INSTALL-MAC.md#additional-dependencies)
+* [Linux](./INSTALL-LINUX.md#additional-dependencies)
+
+Where Docker or balenaEngine are required, they may be installed on the local machine (where the
+balena CLI is executed), on a remote server, or on a balenaOS device running a [balenaOS development
+image](https://www.balena.io/docs/reference/OS/overview/2.x/#dev-vs-prod-images). Reasons why this
+may be desirable include:
+
+* To avoid having to install Docker on the development machine / laptop.
+* To take advantage of a more powerful server (CPU, memory).
+* To build or run images "natively" on an ARM device, avoiding the need for QEMU emulation.
+
+To use a remote Docker Engine (daemon) or balenaEngine, specify the remote machine's IP address and
+port number with the `--dockerHost` and `--dockerPort` command-line options. The `preload` command
+has additional requirements because the bind mount feature is used. For more details, see
+`balena help` for each command or the [online
+reference](https://www.balena.io/docs/reference/cli/#cli-command-reference).

INSTALL-LINUX.md

@@ -0,0 +1,85 @@
+# balena CLI Installation Instructions for Linux
+
+These instructions are suitable for most Linux distributions on Intel x86, such as
+Ubuntu, Debian, Fedora, Arch Linux and other glibc-based distributions.
+For the ARM architecture and for Linux distributions not based on glibc, such as
+Alpine Linux, follow the [NPM Installation](./INSTALL-ADVANCED.md#npm-installation)
+method.
+
+Selected operating system: **Linux**
+
+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.zip", for example:  
+   `balena-cli-vX.Y.Z-linux-x64-standalone.zip`
+
+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-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`
+   can take effect.
+
+4. Check that the installation was successful by running the following commands on a
+   terminal window:  
+   * `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 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 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:
+
+```text
+Defaults   secure_path="/home/james/balena-cli:<pre-existing entries go here>"
+```
+
+If an `/etc/sudoers` file does not exist, or if it does not contain a pre-existing
+`secure_path` setting, do not change it.
+
+If you also have Docker installed, ensure that it can be executed ***without*** `sudo`, so that
+CLI commands like `balena build` and `balena preload` can also be executed without `sudo`.
+Check Docker's [post-installation
+steps](https://docs.docker.com/engine/install/linux-postinstall/) on how to achieve this.
+
+## Additional Dependencies
+
+### build, deploy
+
+These commands require [Docker](https://docs.docker.com/install/overview/) or
+[balenaEngine](https://www.balena.io/engine/) to be available on a local or remote
+machine. Most users will follow [Docker's installation
+instructions](https://docs.docker.com/install/overview/) to install Docker on the same
+workstation as the balena CLI. The [advanced installation
+options](./INSTALL-ADVANCED.md#additional-dependencies) document describes other possibilities.
+
+### balena ssh
+
+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 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 scan
+
+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`.
+
+### balena preload
+
+Like the `build` and `deploy` commands, the `preload` command requires Docker, with the additional
+restriction that Docker must be installed on the local machine (because Docker's bind mounting
+feature is used).

INSTALL-MAC.md

@@ -0,0 +1,74 @@
+# balena CLI Installation Instructions for macOS
+
+These instructions are for the recommended installation option. Advanced users may also be
+interested in [advanced installation options](./INSTALL-ADVANCED.md).
+
+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`  
+
+2. Double click on the downloaded file to run the installer and follow the installer's
+   instructions.
+
+3. Check that the installation was successful:
+   - [Open the Terminal
+   app](https://support.apple.com/en-gb/guide/terminal/apd5265185d-f365-44cb-8b09-71a064a42125/mac).
+   - 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 ssh`, `build`, `deploy`
+and `preload` commands may require additional software to be installed, as described
+in the next section.
+
+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/lib/balena-cli/bin/uninstall
+```
+
+## Additional Dependencies
+
+### build and deploy
+
+These commands require [Docker](https://docs.docker.com/install/overview/) or
+[balenaEngine](https://www.balena.io/engine/) to be available on a local or remote
+machine. Most users will follow [Docker's installation
+instructions](https://docs.docker.com/install/overview/) to install Docker on the same
+workstation as the balena CLI. The [advanced installation
+options](./INSTALL-ADVANCED.md#additional-dependencies) document describes other possibilities.
+
+### balena ssh
+
+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:
+
+* Download the Xcode Command Line Tools from https://developer.apple.com/downloads
+* Or, if you have Xcode installed, open Xcode, choose Preferences → General → Downloads →
+  Components → Command Line Tools → Install.
+* Or, install [Homebrew](https://brew.sh/), then `brew install openssh`
+
+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 preload
+
+Like the `build` and `deploy` commands, the `preload` command requires Docker.
+Preloading balenaOS images for some older device types (like the Raspberry
+Pi 3, but not the Raspberry 4) requires Docker to support the [AUFS storage
+driver](https://docs.docker.com/storage/storagedriver/aufs-driver/). Unfortunately, Docker Desktop
+for Windows and macOS dropped support for the AUFS filesystem in Docker CE versions greater than
+18.06.1. The present workarounds are to either:
+
+* Install the balena CLI on Linux (e.g. Ubuntu) with a virtual machine like VirtualBox.
+  This works because Docker for Linux still supports AUFS. Hint: if using a virtual machine,
+  copy the image file over, rather than accessing it through "file sharing", to avoid errors.
+* Downgrade Docker Desktop to version 18.06.1. Link: [Docker CE for
+  Mac](https://docs.docker.com/docker-for-mac/release-notes/#docker-community-edition-18061-ce-mac73-2018-08-29)
+
+We are working on replacing AUFS with overlay2 in balenaOS images of the affected device types.

INSTALL-WINDOWS.md

@@ -0,0 +1,73 @@
+# balena CLI Installation Instructions for Windows
+
+These instructions are for the recommended installation option. Advanced users may also be
+interested in [advanced installation options](./INSTALL-ADVANCED.md).
+
+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`  
+
+2. Double click on the downloaded file to run the installer and follow the installer's
+   instructions.
+
+3. Check that the installation was successful:
+   - Click on the Windows Start Menu, type PowerShell, and then click
+     on Windows PowerShell.
+   - 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 ssh`, `scan`, `build`,
+`deploy` and `preload` commands may require additional software to be installed, as
+described below.
+
+## Additional Dependencies
+
+### build and deploy
+
+These commands require [Docker](https://docs.docker.com/install/overview/) or
+[balenaEngine](https://www.balena.io/engine/) to be available on a local or remote
+machine. Most users will follow [Docker's installation
+instructions](https://docs.docker.com/install/overview/) to install Docker on the same
+workstation as the balena CLI. The [advanced installation
+options](./INSTALL-ADVANCED.md#additional-dependencies) document describes other possibilities.
+
+### balena ssh
+
+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
+installed](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse)
+if needed. For older versions of Windows, there are several ssh/OpenSSH clients provided by 3rd
+parties.
+
+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 scan
+
+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
+
+### balena preload
+
+Like the `build` and `deploy` commands, the `preload` command requires Docker.
+Preloading balenaOS images for some older device types (like the Raspberry
+Pi 3, but not the Raspberry 4) requires Docker to support the [AUFS storage
+driver](https://docs.docker.com/storage/storagedriver/aufs-driver/). Unfortunately, Docker Desktop
+for Windows and macOS dropped support for the AUFS filesystem in Docker CE versions greater than
+18.06.1. The present workarounds are to either:
+
+* Install the balena CLI on Linux (e.g. Ubuntu) with a virtual machine like VirtualBox.
+  This works because Docker for Linux still supports AUFS. Hint: if using a virtual machine,
+  copy the image file over, rather than accessing it through "file sharing", to avoid errors.
+* Downgrade Docker Desktop to version 18.06.1. Link: [Docker CE for
+  Windows](https://docs.docker.com/docker-for-windows/release-notes/#docker-community-edition-18061-ce-win73-2018-08-29)
+
+We are working on replacing AUFS with overlay2 in balenaOS images of the affected device types.

INSTALL.md

@@ -1,231 +1,12 @@
 # balena CLI Installation Instructions
 
-There are 3 options to choose from to install balena's CLI:
+Please select your operating system:
 
-* [Executable Installer](#executable-installer): the easiest method on Windows and macOS, using the
-  traditional graphical desktop application installers.
-* [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.
+* [Windows](./INSTALL-WINDOWS.md)
+* [macOS](./INSTALL-MAC.md)
+* [Linux](./INSTALL-LINUX.md)
 
-Some specific CLI commands have a few extra installation steps: see section [Additional
-Dependencies](#additional-dependencies).
-
-> **Windows users:**
-> * There is a [YouTube video tutorial](https://www.youtube.com/watch?v=2LApclXFqsg) for installing
->   and getting started with the balena CLI on Windows. (The video uses the standalone zip package
->   option.)
-> * If you are using Microsoft's [Windows Subsystem for
->   Linux](https://docs.microsoft.com/en-us/windows/wsl/about) (WSL), install a balena CLI release
->   for Linux rather than for Windows, like the standalone zip package for Linux. An installation
->   with the graphical executable installer for Windows will **not** work with WSL.
-
-## Executable Installer
-
-Recommended for Windows (but not Windows Subsystem for Linux) and macOS:
-
-1. Download the latest installer from the [releases page](https://github.com/balena-io/balena-cli/releases).
-   Look for a file name that ends with "-installer", for example:  
-   `balena-cli-vX.Y.Z-windows-x64-installer.exe`  
-   `balena-cli-vX.Y.Z-macOS-x64-installer.pkg`
-
-2. Double click the downloaded file to run the installer.  
-   _If you are using macOS Catalina (10.15), [check this known issue and
-   workaround](https://github.com/balena-io/balena-cli/issues/1479)._
-
-3. After the installation completes, close and re-open any open [command
-   terminal](https://www.balena.io/docs/reference/cli/#choosing-a-shell-command-promptterminal)
-   windows so that the changes made by the installer to the PATH environment variable can take
-   effect. Check that the installation was successful by running the following commands on a
-   command terminal:
-
-* `balena version` - should print the installed CLI version
-* `balena help` - should print the balena CLI help
-
-> Note: 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 Zip Package](#standalone-zip-package)
-> instructions for how to modify the PATH variable.
-
-By default, the CLI is installed to the following folders:
-
-OS  | Folders
---- | ---
-Windows: | `C:\Program Files\balena-cli\`
-macOS:   | `/usr/local/lib/balena-cli/` <br> `/usr/local/bin/balena`
-
-## Standalone Zip Package
-
-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.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 zip file contents to any folder you choose. The extracted contents will include a
-   `balena-cli` folder.
-
-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) |
-   [Windows](https://www.computerhope.com/issues/ch000549.htm)
-
-> * If you are using macOS Catalina (10.15), [check this known issue and
->   workaround](https://github.com/balena-io/balena-cli/issues/1479).
-> * **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.
->   It should however work with all "desktop" or "server" distributions, e.g. Ubuntu, Debian, Suse,
->   Fedora, Arch Linux and many more.
-> * 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-cli` folder.
-
-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.
-
-## NPM Installation
-
-If you are a Node.js developer, you may wish to install the balena CLI via [npm](https://www.npmjs.com).
-The npm installation involves building native (platform-specific) binary modules, which require
-some additional development tools to be installed first:
-
-* [Node.js](https://nodejs.org/) version 10 (min **10.20.0**) or 12 (version 14 is not yet fully supported)
-  * **Linux, macOS** and **Windows Subsystem for Linux (WSL):**  
-    Installing Node via [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md) is recommended.
-    When the "system" or "default" Node.js and npm packages are installed with "apt-get" in Linux
-    distributions like Ubuntu, users often report permission or compilation errors when running
-    "npm install". This [sample
-    Dockerfile](https://gist.github.com/pdcastro/5d4d96652181e7da685a32caf629dd44) shows the CLI
-    installation steps on an Ubuntu 18.04 base image.
-* [Python 2.7](https://www.python.org/), [git](https://git-scm.com/), [make](https://www.gnu.org/software/make/), [g++](https://gcc.gnu.org/)
-  * **Linux** and **Windows Subsystem for Linux (WSL):**  
-    `sudo apt-get install -y python git make g++`
-  * **macOS:** install Apple's Command Line Tools by running on a Terminal window:  
-    `xcode-select --install`
-
-On **Windows (not WSL),** the dependencies above and additional ones can be met by installing:
-
-* Node.js from the [Nodejs.org download page](https://nodejs.org/en/download/).
-* The [MSYS2 shell](https://www.msys2.org/), which provides `git`, `make`, `g++`, `ssh`, `rsync`
-  and more:
-  * `pacman -S git openssh rsync gcc make`
-  * [Set a Windows environment variable](https://www.onmsft.com/how-to/how-to-set-an-environment-variable-in-windows-10): `MSYS2_PATH_TYPE=inherit`
-  * Note that a bug in the MSYS2 launch script (`msys2_shell.cmd`) makes text-based
-    interactive CLI menus to misbehave. [Check this Github issue for a
-    workaround](https://github.com/msys2/MINGW-packages/issues/1633#issuecomment-240583890).
-* The Windows Driver Kit (WDK), which is needed to compile some native Node modules. It is **not**
-  necessary to install Visual Studio, only the WDK, which is "step 2" in the following guides:
-  * [WDK for Windows 10](https://docs.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk#download-icon-step-2-install-wdk-for-windows-10-version-1903)
-  * [WDK for earlier versions of Windows](https://docs.microsoft.com/en-us/windows-hardware/drivers/other-wdk-downloads#step-2-install-the-wdk)
-* The [windows-build-tools](https://www.npmjs.com/package/windows-build-tools) npm package (which
-  provides Python 2.7 and more), by running the following command on an [administrator
-  console](https://www.howtogeek.com/194041/how-to-open-the-command-prompt-as-administrator-in-windows-8.1/):
-  
-  `npm install -g --production windows-build-tools`
-
-With these dependencies in place, the balena CLI installation command is:
-
-```sh
-$ npm install balena-cli -g --production --unsafe-perm
-```
-
-`--unsafe-perm` is required when `npm install` is executed as the root user, or on systems where
-the global install directory is not user-writable. It allows npm install steps to download and save
-prebuilt native binaries, and also allows the execution of npm scripts like `postinstall` that are
-used to patch dependencies. It is usually possible to omit `--unsafe-perm` if installing under a
-regular (non-root) user account, especially if using a user-managed node installation such as
-[nvm](https://github.com/creationix/nvm).
-
-
-## Additional Dependencies
-
-* The `balena ssh` command requires a recent version of the `ssh` command-line tool to be available:
-  * macOS and Linux usually already have it installed. Otherwise, search for the available packages
-    on your specific Linux distribution, or for the Mac consider the [Xcode command-line
-    tools](https://developer.apple.com/xcode/features/) or [homebrew](https://brew.sh/).
-
-  * Microsoft started distributing an SSH client with Windows 10, which we understand is
-    automatically installed through Windows Update, but can be manually installed too
-    ([more information](https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse)).
-    For other versions of Windows, there are several ssh/OpenSSH clients provided by 3rd parties.
-
-  * The [`proxytunnel`](http://proxytunnel.sourceforge.net/) package (command-line tool) is needed
-    for the `balena ssh` command to work behind a proxy. It 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 Subsystem for Linux
-    (e.g., by installing Ubuntu through the Microsoft App Store). Check the
-    [README](https://github.com/balena-io/balena-cli/blob/master/README.md) file for proxy
-    configuration instructions.
-
-* The `balena preload`, `balena build` and `balena deploy --build` commands require
-  [Docker](https://docs.docker.com/install/overview/) or [balenaEngine](https://www.balena.io/engine/)
-  to be available:
-  * The `balena preload` command requires the Docker Engine to support the [AUFS storage
-    driver](https://docs.docker.com/storage/storagedriver/aufs-driver/). Docker Desktop for Mac and
-    Windows dropped support for the AUFS filesystem in Docker CE versions greater than 18.06.1, so
-    the workaround is to downgrade to version 18.06.1 (links: [Docker CE for
-    Windows](https://docs.docker.com/docker-for-windows/release-notes/#docker-community-edition-18061-ce-win73-2018-08-29)
-    and [Docker CE for
-    Mac](https://docs.docker.com/docker-for-mac/release-notes/#docker-community-edition-18061-ce-mac73-2018-08-29)).
-    See more details in [CLI issue 1099](https://github.com/balena-io/balena-cli/issues/1099).
-  * Commonly, Docker is installed on the same machine where the CLI is being used, but the
-    `balena build` and `balena deploy` commands can also use a remote Docker Engine (daemon)
-    or balenaEngine (which could be a remote device running a [balenaOS development
-    image](https://www.balena.io/docs/reference/OS/overview/2.x/#dev-vs-prod-images)) by specifying
-    its IP address and port number as command-line options. Check the documentation for each
-    command, e.g. `balena help build`, or the [online
-    reference](https://www.balena.io/docs/reference/cli/#cli-command-reference).
-  * If you are using Microsoft's [Windows Subsystem for
-    Linux](https://docs.microsoft.com/en-us/windows/wsl/about) (WSL) and Docker Desktop for
-    Windows, check the [FAQ item "Docker seems to be
-    unavailable"](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md#docker-seems-to-be-unavailable-error-when-using-windows-subsystem-for-linux-wsl).
-
-* The `balena scan` command requires a multicast DNS (mDNS) service like Bonjour or Avahi:
-  * On Windows, check if 'Bonjour' is installed (Control Panel > Programs and Features).
-    If not, you can download Bonjour for Windows from https://support.apple.com/kb/DL999
-  * Most 'desktop' Linux distributions ship with [Avahi](https://en.wikipedia.org/wiki/Avahi_(software)).
-    Search for the installation command for your distribution. E.g. for Ubuntu:
-    `sudo apt-get install avahi-daemon`
-  * macOS comes with [Bonjour](https://en.wikipedia.org/wiki/Bonjour_(software)) built-in.
-  
-* The `balena os configure` command is currently not supported on Windows natively. Windows users are advised 
-  to install the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about) (WSL) 
-  with Ubuntu, and use the Linux release of the balena CLI.
-  
-
-## Configuring SSH keys
-
-The `balena ssh` command requires an SSH key to be added to your balena account. If you had
-already added a SSH key in order to [deploy with 'git push'](https://www.balena.io/docs/learn/getting-started/raspberrypi3/nodejs/#adding-an-ssh-key),
-then you are probably done and may skip this section. You can check whether you already have
-an SSH key in your balena account with the `balena keys` command, or by visiting the
-[balena web dashboard](https://dashboard.balena-cloud.com/), clicking on your name -> Preferences
--> SSH Keys.
-
-> Note: An "SSH key" actually consists of a public/private key pair. A typical name for the private
-> key file is "id_rsa", and a typical name for the public key file is "id_rsa.pub". Both key files
-> are saved to your computer (with the private key optionally protected by a password), but only
-> the public key is saved to your balena account. This means that if you change computers or
-> otherwise lose the private key, _you cannot recover the private key through your balena account._
-> You can however add new keys, and delete the old ones.
-
-If you don't have an SSH key in your balena account:
-
-* If you have an existing SSH key in your computer that you would like to use, you can add it
-  to your balena account through the balena web dashboard (Preferences -> SSH Keys), or through
-  the CLI itself:
-
-```bash
-# Windows 10 (cmd.exe prompt) example:
-$ balena key add MyKey %userprofile%\.ssh\id_rsa.pub
-# Linux / macOS example:
-$ balena key add MyKey ~/.ssh/id_rsa.pub
-```
-
-* To generate a new key, you can follow [GitHub's documentation](https://help.github.com/en/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent),
-  skipping the step about adding the key to your GitHub account, and instead adding the key to
-  your balena account as described above.
+> Note regarding WSL ([Windows Subsystem for
+> Linux](https://docs.microsoft.com/en-us/windows/wsl/about))  
+> If you would like to use WSL, follow the installations instructions for Linux
+> rather than Windows, as WSL consists of a Linux environment.

README.md

@@ -1,68 +1,69 @@
 # balena CLI
 
-The official balena CLI tool.
+The official balena Command Line Interface.
 
 [![npm version](https://badge.fury.io/js/balena-cli.svg)](http://badge.fury.io/js/balena-cli)
 [![dependencies](https://david-dm.org/balena-io/balena-cli.svg)](https://david-dm.org/balena-io/balena-cli)
 
 ## About
 
-The balena CLI (Command-Line Interface) allows you to interact with the balenaCloud and the
-[balena API](https://www.balena.io/docs/reference/api/overview/) through a terminal window
-on Linux, macOS or Windows. You can also write shell scripts around it, or import its Node.js
-modules to use it programmatically.
-As an [open-source project on GitHub](https://github.com/balena-io/balena-cli/), your contribution
-is also welcome!
+The balena CLI is a Command Line Interface for [balenaCloud](https://www.balena.io/cloud/) or
+[openBalena](https://www.balena.io/open/). It is a software tool available for Windows, macOS and
+Linux, used through a command prompt / terminal window. It can be used interactively or invoked in
+scripts. The balena CLI builds on the [balena API](https://www.balena.io/docs/reference/api/overview/)
+and the [balena SDK](https://www.balena.io/docs/reference/sdk/node-sdk/), and can also be directly
+imported in Node.js applications. The balena CLI is an [open-source project on
+GitHub](https://github.com/balena-io/balena-cli/), and your contribution is also welcome!
 
 ## Installation
 
-Check the [balena CLI installation instructions on GitHub](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md).
+Check the [balena CLI installation instructions on
+GitHub](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md).
 
-## Getting Started
-
-### Choosing a shell (command prompt/terminal)
+## Choosing a shell (command prompt/terminal)
 
 On **Windows,** the standard Command Prompt (`cmd.exe`) and
 [PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell?view=powershell-6)
-are supported. We are aware of users also having a good experience with alternative shells,
-including:
+are supported. Alternative shells include:
 
 * [MSYS2](https://www.msys2.org/):
   * Install additional packages with the command:  
-    `pacman -S git openssh rsync`
+    `pacman -S git gcc make openssh p7zip`
   * [Set a Windows environment variable](https://www.onmsft.com/how-to/how-to-set-an-environment-variable-in-windows-10): `MSYS2_PATH_TYPE=inherit`
   * Note that a bug in the MSYS2 launch script (`msys2_shell.cmd`) makes text-based interactive CLI
     menus to break. [Check this Github issue for a
     workaround](https://github.com/msys2/MINGW-packages/issues/1633#issuecomment-240583890).
-* [MSYS](http://www.mingw.org/wiki/MSYS): select the `msys-rsync` and `msys-openssh` packages too
+
+* [MSYS](http://www.mingw.org/wiki/MSYS)
 * [Git for Windows](https://git-for-windows.github.io/)
   * During the installation, you will be prompted to choose between _"Use MinTTY"_ and _"Use
     Windows' default console window"._ Choose the latter, because of the same [MSYS2
     bug](https://github.com/msys2/MINGW-packages/issues/1633) mentioned above (Git for Windows
     actually uses MSYS2). For a screenshot, check this
     [comment](https://github.com/balena-io/balena-cli/issues/598#issuecomment-556513098).
+
 * Microsoft's [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about)
   (WSL). In this case, a Linux distribution like Ubuntu is installed via the Microsoft Store, and a
-  balena CLI release **for Linux** is recommended. See
-  [FAQ](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md) for using balena
-  CLI with WSL and Docker Desktop for Windows.
+  balena CLI release **for Linux** should be selected. See
+  [FAQ](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md) for using the
+  balena CLI with WSL and Docker Desktop for Windows.
 
-On **macOS** and **Linux,** the standard terminal window is supported. _Optionally,_ `bash` command
+On **macOS** and **Linux,** the standard terminal window is supported. Optionally, `bash` command
 auto completion may be enabled by copying the
-[balena-completion.bash](https://github.com/balena-io/balena-cli/blob/master/balena-completion.bash)
+[balena_comp](https://github.com/balena-io/balena-cli/blob/master/completion/balena-completion.bash)
 file to your system's `bash_completion` directory: check [Docker's command completion
 guide](https://docs.docker.com/compose/completion/) for system setup instructions.
 
-### Logging in
+## Logging in
 
 Several CLI commands require access to your balenaCloud account, for example in order to push a
-new release to your application. Those commands require creating a CLI login session by running:
+new release to your fleet. Those commands require creating a CLI login session by running:
 
 ```sh
 $ balena login
 ```
 
-### Proxy support
+## Proxy support
 
 HTTP(S) proxies can be configured through any of the following methods, in precedence order
 (from higher to lower):
@@ -76,7 +77,6 @@ HTTP(S) proxies can be configured through any of the following methods, in prece
   file](https://www.npmjs.com/package/balena-settings-client#documentation). It may be:
   * A string in URL format, e.g. `proxy: 'http://localhost:8000'`
   * An object in the format:
-
     ```yaml
     proxy:
         protocol: 'http'
@@ -88,19 +88,26 @@ 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`.
 
-> Note: The `balena ssh` command has additional setup requirements to work behind a proxy.
-> Check the [installation instructions](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md),
-> and ensure that the proxy server is configured to allow proxy requests to ssh port 22, using
-> SSL encryption. For example, in the case of the [Squid](http://www.squid-cache.org/) proxy
-> server, it should be configured with the following rules in the `squid.conf` file:  
-> `acl SSL_ports port 22`  
-> `acl Safe_ports port 22`  
+### Proxy setup for balena ssh
 
-#### Proxy exclusion
+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
+Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about) (e.g., by installing
+Ubuntu through the Microsoft App Store).
+
+Ensure that the proxy server is configured to allow proxy requests to ssh port 22, using
+SSL encryption. For example, in the case of the [Squid](http://www.squid-cache.org/) proxy
+server, it should be configured with the following rules in the `squid.conf` file:  
+`acl SSL_ports port 22`  
+`acl Safe_ports port 22`  
+
+### Proxy exclusion
 
 The `BALENARC_NO_PROXY` variable may be used to exclude specified destinations from proxying.
 
-> * This feature requires balena CLI version 11.30.8 or later. In the case of the npm [installation
+> * 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 ssh` target from proxying (IP address or `.local` hostname), the
@@ -129,32 +136,38 @@ address like `192.168.1.2`.
 ## Command reference documentation
 
 The full CLI command reference is available [on the web](https://www.balena.io/docs/reference/cli/
-) or by running `balena help` and `balena help --verbose`.
+) or by running `balena help --verbose`.
 
 ## Support, FAQ and troubleshooting
 
-If you come across any problems or would like to get in touch:
+To learn more, troubleshoot issues, or to contact us for support:
 
-* Check our [FAQ / troubleshooting document](https://github.com/balena-io/balena-cli/blob/master/TROUBLESHOOTING.md).
-* Ask us a question through the [balenaCloud forum](https://forums.balena.io/c/balena-cloud).
-* For bug reports or feature requests,
-  [have a look at the GitHub issues or create a new one](https://github.com/balena-io/balena-cli/issues/).
+* 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)
+
+For CLI bug reports or feature requests, check the
+[CLI GitHub issues](https://github.com/balena-io/balena-cli/issues/).
 
 ## Deprecation policy
 
 The balena CLI uses [semver versioning](https://semver.org/), with the concepts
 of major, minor and patch version releases.
 
-The latest release of the previous major version of the balena CLI will remain
-compatible with the balenaCloud backend services for one year from the date when
-the next major version is released. For example, balena CLI v10.17.5, as the
-latest v10 release, would remain compatible with the balenaCloud backend for one
-year from the date when v11.0.0 is released.
+The latest release of a major version of the balena CLI will remain compatible with
+the balenaCloud backend services for at least one year from the date when the
+following major version is released. For example, balena CLI v11.36.0, as the
+latest v11 release, would remain compatible with the balenaCloud backend for one
+year from the date when v12.0.0 was released.
 
-At the end of this period, the older major version is considered deprecated and
-some of the functionality that depends on balenaCloud services may stop working
-at any time.
-Users are encouraged to regularly update the balena CLI to the latest version.
+Half way through to that period (6 months after the release of the next major
+version), older major versions of the balena CLI will start printing a deprecation
+warning message when it is used interactively (when `stderr` is attached to a TTY
+device file). At the end of that period, older major versions will exit with an
+error message unless the `--unsupported` flag is used.  This behavior was
+introduced in CLI version 12.47.0 and is also documented by `balena help`.
+To take advantage of the latest backend features and ensure compatibility, users
+are encouraged to regularly update the balena CLI to the latest version.
 
 ## Contributing (including editing documentation files)
 

TROUBLESHOOTING.md

@@ -1,8 +1,6 @@
-# FAQ & Troubleshooting
+# balena CLI FAQ & Troubleshooting
 
-This document contains some common issues, questions and answers related to the balena CLI.
-
-## Where is my configuration file?
+## Where is the balena CLI's configuration file located?
 
 The per-user configuration file lives in `$HOME/.balenarc.yml` or `%UserProfile%\_balenarc.yml`, in
 Unix based operating systems and Windows respectively.
@@ -10,53 +8,48 @@ Unix based operating systems and Windows respectively.
 The balena CLI also attempts to read a `balenarc.yml` file in the current directory, which takes
 precedence over the per-user configuration file.
 
-## How do I point the balena CLI to staging?
+## How do I point the balena CLI to the staging environment?
 
-The easiest way is to set the `BALENARC_BALENA_URL=balena-staging.com` environment variable.
-
-Alternatively, you can edit your configuration file and set `balenaUrl: balena-staging.com` to
-persist this setting.
+Set the `BALENARC_BALENA_URL=balena-staging.com` environment variable, or add
+`balenaUrl: balena-staging.com` to the balena CLI's configuration file.
 
 ## How do I make the balena CLI persist data in another directory?
 
-The balena CLI persists your session token, as well as cached images in `$HOME/.balena` or
-`%UserProfile%\_balena`.
+The balena CLI persists the session token, as well as cached assets, to `$HOME/.balena` or
+`%UserProfile%\_balena`. This directory can be changed by setting an environment variable,
+`BALENARC_DATA_DIRECTORY=/opt/balena`, or by adding `dataDirectory: /opt/balena` to the CLI's
+configuration file, replacing `/opt/balena` with the desired directory.
 
-Pointing the balena CLI to persist data in another location is necessary in certain environments,
-like a server, where there is no home directory, or a device running balenaOS, which erases all
-data after a restart.
+## After burning to an SD card, my device doesn't boot
 
-You can accomplish this by setting `BALENARC_DATA_DIRECTORY=/opt/balena` or adding `dataDirectory:
-/opt/balena` to your configuration file, replacing `/opt/balena` with your desired directory.
+Check whether the downloaded image is incomplete (download was interrupted) or corrupted.
 
-## After burning to an sdcard, my device doesn't boot
+Try clearing the cache (`%HOME/.balena/cache` or `C:\Users\<user>\_balena\cache`) and running the
+command again.
 
-- The downloaded image is not complete (download was interrupted).
+## I get a permission error when burning to an SD card
 
-Please clean the cache (`%HOME/.balena/cache` or `C:\Users\<user>\_balena\cache`) and run the command again. In the future, the CLI will check that the image is not complete and clean the cache for you.
+Check whether the SD card is locked (a physical switch on the side of the card).
 
-## I get a permission error when burning to an sdcard
+## I get `connect ETIMEDOUT` with `balena tunnel`
 
-- The SDCard is locked.
+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
 
-### I get EINVAL errors on Cygwin
+## I get EINVAL errors on Cygwin
 
-The errors look something like this:
+The errors may look something like this:
 
 ```
 net.js:156
     this._handle.open(options.fd);
                  ^
 Error: EINVAL, invalid argument
-  at new Socket (net.js:156:18)
-  at process.stdin (node.js:664:19)
-  at Object.Interface.createInterface (C:\cygwin\home\Juan Cruz Viotti\Projects\balena-cli\node_modules\inquirer\node_modules\readline2\index.js:31:43)
-  at PromptUI.UI (C:\cygwin\home\Juan Cruz Viotti\Projects\balena-cli\node_modules\inquirer\lib\ui\baseUI.js:23:40)
-  at new PromptUI (C:\cygwin\home\Juan Cruz Viotti\Projects\balena-cli\node_modules\inquirer\lib\ui\prompt.js:26:8)
-  at Object.promptModule [as prompt] (C:\cygwin\home\Juan Cruz Viotti\Projects\balena-cli\node_modules\inquirer\lib\inquirer.js:27:14)
 ```
 
-- Some interactive widgets don't work on `Cygwin`. If you're running Windows, it's preferrable that you use `cmd.exe`, as `Cygwin` is [not official supported by Node.js](https://github.com/chjj/blessed/issues/56#issuecomment-42671945).
+Some interactive widgets don't work on `Cygwin`. On Windows, PowerShell or `cmd.exe` are better
+supported. Alternative shells are [listed in the README
+file](./README.md#choosing-a-shell-command-promptterminal).
 
 ## I get `Invalid MBR boot signature` when configuring a device
 
@@ -76,7 +69,9 @@ Or in Windows:
 
 ## I get `EACCES: permission denied` when logging in
 
-The balena CLI stores the session token in `$HOME/.balena` or `C:\Users\<user>\_balena` in UNIX based operating systems and Windows respectively. This error usually indicates that the user doesn't have permissions over that directory, which can happen if you ran the balena CLI as `root`, and thus the directory got owned by him.
+The balena CLI stores the session token in `$HOME/.balena` or `C:\Users\<user>\_balena` in UNIX based
+operating systems and Windows respectively. This error usually indicates that the user doesn't have
+permissions over that directory, which can happen if the CLI was executed as the `root` user.
 
 Try resetting the ownership by running:
 
@@ -86,7 +81,15 @@ $ sudo chown -R <user> $HOME/.balena
 
 ## 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 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` and the like), including UTF-8 misconfiguration, the use of unsupported ASCII control characters in shell prompt formatting (e.g. the `$PS1` env var) or the output of tools or log files that use colored text. The issue can sometimes be fixed by resizing the client terminal window, or by running one or more of the following commands on the shell:
+Users sometimes come across broken line wrapping or cursor behavior in text terminals, for example
+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`
+and the like on the remote machine), including UTF-8 misconfiguration, the use of unsupported ASCII
+control characters in shell prompt formatting (e.g. the `$PS1` env var) or the output of tools or
+log files that use colored text. The issue can sometimes be fixed by simply resizing the client
+terminal window, or by running one or more of the following commands on the shell:
 
 ```sh
 export TERMINAL=linux
@@ -112,10 +115,10 @@ 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
-zip package for Linux. However, commands like "balena build" that contact a local Docker daemon,
-like the Docker Desktop for Windows, will try to reach Docker 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:
+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:
 
 - Open the Docker Desktop for Windows settings panel and tick the checkbox _"Expose daemon on tcp://localhost:2375 without TLS"._
 - On the WSL command line, set an env var:  

appveyor.yml

@@ -1,43 +0,0 @@
-# appveyor file
-# http://www.appveyor.com/docs/appveyor-yml
-
-image: Visual Studio 2017
-
-init:
-  - git config --global core.autocrlf input
-
-cache:
-  - C:\Users\appveyor\.node-gyp
-  - '%AppData%\npm-cache'
-
-matrix:
-  fast_finish: true
-
-# what combinations to test
-environment:
-  matrix:
-    - nodejs_version: 10
-
-install:
-  - ps: Install-Product node $env:nodejs_version x64
-  - set PATH=%APPDATA%\npm;%PATH%
-  - npm config set python 'C:\Python27\python.exe'
-  - npm --version
-  # - npm install
-
-build: off
-test: off
-deploy: off
-
-test_script:
-  - node --version
-  - npm --version
-  # - npm test
-
-deploy_script:
-  - node --version
-  - npm --version
-  # - npm run build:standalone
-  # - npm run build:installer
-  # - IF "%APPVEYOR_REPO_TAG%" == "true" (npm run release)
-  # - IF NOT "%APPVEYOR_REPO_TAG%" == "true" (echo 'Not tagged, skipping deploy')

automation/build-bin.ts

@@ -15,34 +15,38 @@
  * limitations under the License.
  */
 
-import type { JsonVersions } from '../lib/actions-oclif/version';
+import type { JsonVersions } from '../lib/commands/version';
 
-import { run as oclifRun } from '@oclif/dev-cli';
+import { run as oclifRun } from 'oclif';
 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 * as util from 'util';
+import { promisify } from 'util';
 
-import { stripIndent } from '../lib/utils/lazy';
+import { stripIndent } from '../build/utils/lazy';
 import {
 	diffLines,
-	getSubprocessStdout,
 	loadPackageJson,
-	MSYS2_BASH,
 	ROOT,
 	StdOutTap,
 	whichSpawn,
 } from './utils';
 
+const execFileAsync = promisify(execFile);
+
 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);
@@ -60,7 +64,7 @@ const standaloneZips: PathByPlatform = {
 
 const oclifInstallers: PathByPlatform = {
 	darwin: dPath('macos', `balena-${version}.pkg`),
-	win32: dPath('win', `balena-${version}-${arch}.exe`),
+	win32: dPath('win32', `balena-${version}-${arch}.exe`),
 };
 
 const renamedOclifInstallers: PathByPlatform = {
@@ -92,6 +96,7 @@ async function diffPkgOutput(pkgOut: string) {
 		'> pkg@',
 		'> Fetching base Node.js binaries',
 		'  fetched-',
+		'prebuild-install WARN install No prebuilt binaries found',
 	];
 	const modulesRE =
 		process.platform === 'win32'
@@ -243,7 +248,17 @@ async function testPkg() {
 	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)
-	const stdout = await getSubprocessStdout(pkgBalenaPath, ['version', '-j']);
+	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 {
@@ -260,6 +275,10 @@ async function testPkg() {
 			`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)');
 }
 
@@ -292,10 +311,96 @@ async function zipPkg() {
 		archive.on('warning', console.warn);
 
 		archive.pipe(outputStream);
-		archive.finalize();
+		archive.finalize().catch(reject);
 	});
 }
 
+async function signFilesForNotarization() {
+	console.log('Deleting unneeded zip files...');
+	await new Promise((resolve, reject) => {
+		klaw('node_modules/')
+			.on('data', (item: { path: string; stats: Stats }) => {
+				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')
+				) {
+					console.log('Removing zip', item.path);
+					fs.unlinkSync(item.path);
+				}
+			})
+			.on('end', resolve)
+			.on('error', reject);
+	});
+	// Sign all .node files first
+	console.log('Signing .node files...');
+	await new Promise((resolve, reject) => {
+		klaw('node_modules/')
+			.on('data', async (item: { path: string; stats: Stats }) => {
+				if (!item.stats.isFile()) {
+					return;
+				}
+				if (path.basename(item.path).endsWith('.node')) {
+					console.log('running command:', 'codesign', [
+						'-d',
+						'-f',
+						'-s',
+						'Developer ID Application: Balena Ltd (66H43P8FRG)',
+						item.path,
+					]);
+					await whichSpawn('codesign', [
+						'-d',
+						'-f',
+						'-s',
+						'Developer ID Application: Balena Ltd (66H43P8FRG)',
+						item.path,
+					]);
+				}
+			})
+			.on('end', resolve)
+			.on('error', reject);
+	});
+	console.log('Signing other binaries...');
+	console.log('running command:', 'codesign', [
+		'-d',
+		'-f',
+		'--options=runtime',
+		'-s',
+		'Developer ID Application: Balena Ltd (66H43P8FRG)',
+		'node_modules/denymount/bin/denymount',
+	]);
+	await whichSpawn('codesign', [
+		'-d',
+		'-f',
+		'--options=runtime',
+		'-s',
+		'Developer ID Application: Balena Ltd (66H43P8FRG)',
+		'node_modules/denymount/bin/denymount',
+	]);
+	console.log('running command:', 'codesign', [
+		'-d',
+		'-f',
+		'--options=runtime',
+		'-s',
+		'Developer ID Application: Balena Ltd (66H43P8FRG)',
+		'node_modules/macmount/bin/macmount',
+	]);
+	await whichSpawn('codesign', [
+		'-d',
+		'-f',
+		'--options=runtime',
+		'-s',
+		'Developer ID Application: Balena Ltd (66H43P8FRG)',
+		'node_modules/macmount/bin/macmount',
+	]);
+}
+
 export async function buildStandaloneZip() {
 	console.log(`Building standalone zip package for CLI ${version}`);
 	try {
@@ -326,8 +431,6 @@ async function renameInstallerFiles() {
 async function signWindowsInstaller() {
 	if (process.env.CSC_LINK && process.env.CSC_KEY_PASSWORD) {
 		const exeName = renamedOclifInstallers[process.platform];
-		const execFileAsync = util.promisify<string, string[], void>(execFile);
-
 		console.log(`Signing installer "${exeName}"`);
 		await execFileAsync(MSYS2_BASH, [
 			'sign-exe.sh',
@@ -344,7 +447,21 @@ async function signWindowsInstaller() {
 }
 
 /**
- * Run the `oclif-dev pack:win` or `pack:macos` command (depending on the value
+ * Wait for Apple Installer Notarization to continue
+ */
+async function notarizeMacInstaller(): Promise<void> {
+	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
  * 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.
@@ -369,8 +486,12 @@ export async function buildOclifInstaller() {
 			console.log(`rimraf(${dir})`);
 			await Bluebird.fromCallback((cb) => rimraf(dir, cb));
 		}
+		if (process.platform === 'darwin') {
+			console.log('Signing files for notarization...');
+			await signFilesForNotarization();
+		}
 		console.log('=======================================================');
-		console.log(`oclif-dev "${packCmd}" "${packOpts.join('" "')}"`);
+		console.log(`oclif "${packCmd}" "${packOpts.join('" "')}"`);
 		console.log(`cwd="${process.cwd()}" ROOT="${ROOT}"`);
 		console.log('=======================================================');
 		await oclifRun([packCmd].concat(...packOpts));
@@ -381,6 +502,10 @@ export async function buildOclifInstaller() {
 		// (`oclif.macos.sign` section).
 		if (process.platform === 'win32') {
 			await signWindowsInstaller();
+		} else if (process.platform === 'darwin') {
+			console.log('Notarizing package...');
+			await notarizeMacInstaller(); // Notarize
+			console.log('Package notarized.');
 		}
 		console.log(`oclif installer build completed`);
 	}

automation/capitanodoc/capitanodoc.ts

@@ -26,145 +26,163 @@ import { MarkdownFileParser } from './utils';
  * some content to this object.
  */
 const capitanoDoc = {
-	title: 'Balena CLI Documentation',
+	title: 'balena CLI Documentation',
 	introduction: '',
 	categories: [
 		{
 			title: 'API keys',
-			files: ['build/actions-oclif/api-key/generate.js'],
+			files: ['build/commands/api-key/generate.js'],
 		},
 		{
-			title: 'Application',
+			title: 'Fleet',
 			files: [
-				'build/actions-oclif/apps.js',
-				'build/actions-oclif/app/index.js',
-				'build/actions-oclif/app/create.js',
-				'build/actions-oclif/app/rm.js',
-				'build/actions-oclif/app/restart.js',
+				'build/commands/fleets.js',
+				'build/commands/fleet/index.js',
+				'build/commands/fleet/create.js',
+				'build/commands/fleet/purge.js',
+				'build/commands/fleet/rename.js',
+				'build/commands/fleet/restart.js',
+				'build/commands/fleet/rm.js',
 			],
 		},
 		{
 			title: 'Authentication',
 			files: [
-				'build/actions-oclif/login.js',
-				'build/actions-oclif/logout.js',
-				'build/actions-oclif/whoami.js',
+				'build/commands/login.js',
+				'build/commands/logout.js',
+				'build/commands/whoami.js',
 			],
 		},
 		{
 			title: 'Device',
 			files: [
-				'build/actions-oclif/device/identify.js',
-				'build/actions-oclif/device/init.js',
-				'build/actions-oclif/device/index.js',
-				'build/actions-oclif/device/move.js',
-				'build/actions-oclif/device/reboot.js',
-				'build/actions-oclif/device/register.js',
-				'build/actions-oclif/device/rename.js',
-				'build/actions-oclif/device/rm.js',
-				'build/actions-oclif/device/shutdown.js',
-				'build/actions-oclif/devices/index.js',
-				'build/actions-oclif/devices/supported.js',
-				'build/actions-oclif/device/os-update.js',
-				'build/actions-oclif/device/public-url.js',
+				'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/actions-oclif/envs.js',
-				'build/actions-oclif/env/add.js',
-				'build/actions-oclif/env/rename.js',
-				'build/actions-oclif/env/rm.js',
+				'build/commands/envs.js',
+				'build/commands/env/add.js',
+				'build/commands/env/rename.js',
+				'build/commands/env/rm.js',
 			],
 		},
 		{
 			title: 'Tags',
 			files: [
-				'build/actions-oclif/tags.js',
-				'build/actions-oclif/tag/rm.js',
-				'build/actions-oclif/tag/set.js',
+				'build/commands/tags.js',
+				'build/commands/tag/rm.js',
+				'build/commands/tag/set.js',
 			],
 		},
 		{
 			title: 'Help and Version',
-			files: ['build/actions/help.js', 'build/actions-oclif/version.js'],
+			files: ['help', 'build/commands/version.js'],
 		},
 		{
 			title: 'Keys',
 			files: [
-				'build/actions-oclif/keys.js',
-				'build/actions-oclif/key/index.js',
-				'build/actions-oclif/key/add.js',
-				'build/actions-oclif/key/rm.js',
+				'build/commands/keys.js',
+				'build/commands/key/index.js',
+				'build/commands/key/add.js',
+				'build/commands/key/rm.js',
 			],
 		},
 		{
 			title: 'Logs',
-			files: ['build/actions-oclif/logs.js'],
+			files: ['build/commands/logs.js'],
 		},
 		{
 			title: 'Network',
 			files: [
-				'build/actions-oclif/scan.js',
-				'build/actions-oclif/ssh.js',
-				'build/actions-oclif/tunnel.js',
+				'build/commands/scan.js',
+				'build/commands/ssh.js',
+				'build/commands/tunnel.js',
 			],
 		},
 		{
 			title: 'Notes',
-			files: ['build/actions-oclif/note.js'],
+			files: ['build/commands/note.js'],
 		},
 		{
 			title: 'OS',
 			files: [
-				'build/actions-oclif/os/build-config.js',
-				'build/actions-oclif/os/configure.js',
-				'build/actions-oclif/os/versions.js',
-				'build/actions-oclif/os/download.js',
-				'build/actions-oclif/os/initialize.js',
+				'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/actions-oclif/config/generate.js',
-				'build/actions-oclif/config/inject.js',
-				'build/actions-oclif/config/read.js',
-				'build/actions-oclif/config/reconfigure.js',
-				'build/actions-oclif/config/write.js',
+				'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/actions-oclif/preload.js'],
+			files: ['build/commands/preload.js'],
 		},
 		{
 			title: 'Push',
-			files: ['build/actions-oclif/push.js'],
+			files: ['build/commands/push.js'],
 		},
 		{
 			title: 'Settings',
-			files: ['build/actions-oclif/settings.js'],
+			files: ['build/commands/settings.js'],
 		},
 		{
 			title: 'Local',
 			files: [
-				'build/actions-oclif/local/configure.js',
-				'build/actions-oclif/local/flash.js',
+				'build/commands/local/configure.js',
+				'build/commands/local/flash.js',
 			],
 		},
 		{
 			title: 'Deploy',
-			files: ['build/actions-oclif/build.js', 'build/actions-oclif/deploy.js'],
+			files: ['build/commands/build.js', 'build/commands/deploy.js'],
 		},
 		{
 			title: 'Platform',
-			files: ['build/actions-oclif/join.js', 'build/actions-oclif/leave.js'],
+			files: ['build/commands/join.js', 'build/commands/leave.js'],
 		},
 		{
 			title: 'Utilities',
-			files: ['build/actions-oclif/util/available-drives.js'],
+			files: ['build/commands/util/available-drives.js'],
+		},
+		{
+			title: 'Support',
+			files: ['build/commands/support.js'],
 		},
 	],
 };
@@ -191,7 +209,9 @@ export async function getCapitanoDoc(): Promise<typeof capitanoDoc> {
 			return match && match[2];
 		}),
 		mdParser.getSectionOfTitle('Installation'),
-		mdParser.getSectionOfTitle('Getting Started'),
+		mdParser.getSectionOfTitle('Choosing a shell (command prompt/terminal)'),
+		mdParser.getSectionOfTitle('Logging in'),
+		mdParser.getSectionOfTitle('Proxy support'),
 		mdParser.getSectionOfTitle('Support, FAQ and troubleshooting'),
 		mdParser.getSectionOfTitle('Deprecation policy'),
 	]);

automation/capitanodoc/doc-types.d.ts

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 import { Command as OclifCommandClass } from '@oclif/command';
-import { CommandDefinition as CapitanoCommand } from 'capitano';
 
 type OclifCommand = typeof OclifCommandClass;
 
@@ -27,7 +26,7 @@ export interface Document {
 
 export interface Category {
 	title: string;
-	commands: Array<CapitanoCommand | OclifCommand>;
+	commands: OclifCommand[];
 }
 
-export { CapitanoCommand, OclifCommand };
+export { OclifCommand };

automation/capitanodoc/index.ts

@@ -14,12 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import * as _ from 'lodash';
 import * as path from 'path';
-
 import { getCapitanoDoc } from './capitanodoc';
-import { CapitanoCommand, 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
@@ -40,11 +39,7 @@ export async function renderMarkdown(): Promise<string> {
 		};
 
 		for (const jsFilename of commandCategory.files) {
-			category.commands.push(
-				...(jsFilename.includes('actions-oclif')
-					? importOclifCommands(jsFilename)
-					: importCapitanoCommands(jsFilename)),
-			);
+			category.commands.push(...importOclifCommands(jsFilename));
 		}
 		result.categories.push(category);
 	}
@@ -52,27 +47,48 @@ export async function renderMarkdown(): Promise<string> {
 	return markdown.render(result);
 }
 
-function importCapitanoCommands(jsFilename: string): CapitanoCommand[] {
-	const actions = require(path.join(process.cwd(), jsFilename));
-	const commands: CapitanoCommand[] = [];
+// 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.
 
-	if (actions.signature) {
-		commands.push(_.omit(actions, 'action') as any);
-	} else {
-		for (const actionName of Object.keys(actions)) {
-			const actionCommand = actions[actionName];
-			commands.push(_.omit(actionCommand, 'action') as any);
-		}
-	}
-	return commands;
+		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 = require(path.join(process.cwd(), jsFilename))
-		.default as OclifCommand;
+
+	const command: OclifCommand =
+		jsFilename === 'help'
+			? (new FakeHelpCommand() as unknown as OclifCommand)
+			: (require(path.join(process.cwd(), jsFilename)).default as OclifCommand);
+
 	return [command];
 }
 
@@ -85,8 +101,9 @@ async function printMarkdown() {
 		console.log(await renderMarkdown());
 	} catch (error) {
 		console.error(error);
-		process.exit(1);
+		process.exitCode = 1;
 	}
 }
 
+// tslint:disable-next-line:no-floating-promises
 printMarkdown();

automation/capitanodoc/markdown.ts

@@ -20,33 +20,10 @@ import * as _ from 'lodash';
 
 import { getManualSortCompareFunction } from '../../lib/utils/helpers';
 import { capitanoizeOclifUsage } from '../../lib/utils/oclif-utils';
-import { CapitanoCommand, Category, Document, OclifCommand } from './doc-types';
-import * as utils from './utils';
-
-function renderCapitanoCommand(command: CapitanoCommand): string[] {
-	const result = [`## ${ent.encode(command.signature)}`, command.help!];
-
-	if (!_.isEmpty(command.options)) {
-		result.push('### Options');
-
-		for (const option of command.options!) {
-			if (option == null) {
-				throw new Error(`Undefined option in markdown generation!`);
-			}
-			if (option.description == null) {
-				throw new Error(`Undefined option.description in markdown generation!`);
-			}
-			result.push(
-				`#### ${utils.parseCapitanoOption(option)}`,
-				option.description,
-			);
-		}
-	}
-	return result;
-}
+import { Category, Document, OclifCommand } from './doc-types';
 
 function renderOclifCommand(command: OclifCommand): string[] {
-	const result = [`## ${ent.encode(command.usage)}`];
+	const result = [`## ${ent.encode(command.usage || '')}`];
 	const description = (command.description || '')
 		.split('\n')
 		.slice(1) // remove the first line, which oclif uses as help header
@@ -86,11 +63,7 @@ function renderOclifCommand(command: OclifCommand): string[] {
 function renderCategory(category: Category): string[] {
 	const result = [`# ${category.title}`];
 	for (const command of category.commands) {
-		result.push(
-			...(typeof command === 'object'
-				? renderCapitanoCommand(command)
-				: renderOclifCommand(command)),
-		);
+		result.push(...renderOclifCommand(command));
 	}
 	return result;
 }
@@ -107,10 +80,7 @@ function renderToc(categories: Category[]): string[] {
 		result.push(
 			category.commands
 				.map((command) => {
-					const signature =
-						typeof command === 'object'
-							? command.signature // Capitano
-							: capitanoizeOclifUsage(command.usage); // oclif
+					const signature = capitanoizeOclifUsage(command.usage);
 					return `\t- [${ent.encode(signature)}](${getAnchor(signature)})`;
 				})
 				.join('\n'),
@@ -134,12 +104,10 @@ function sortCommands(doc: Document): void {
 	for (const category of doc.categories) {
 		if (category.title in manualCategorySorting) {
 			category.commands = category.commands.sort(
-				getManualSortCompareFunction<CapitanoCommand | OclifCommand, string>(
+				getManualSortCompareFunction<OclifCommand, string>(
 					manualCategorySorting[category.title],
-					(cmd: CapitanoCommand | OclifCommand, x: string) =>
-						typeof cmd === 'object' // Capitano vs oclif command
-							? cmd.signature.replace(/\W+/g, ' ').includes(x)
-							: (cmd.usage || '').toString().replace(/\W+/g, ' ').includes(x),
+					(cmd: OclifCommand, x: string) =>
+						(cmd.usage || '').toString().replace(/\W+/g, ' ').includes(x),
 				),
 			);
 		}

automation/check-doc.js

@@ -24,15 +24,15 @@ const simplegit = require('simple-git/promise');
 const ROOT = path.normalize(path.join(__dirname, '..'));
 
 /**
- * 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
+ * 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
  * `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, 'doc', 'cli.markdown');
+	const docFile = path.join(ROOT, 'docs', 'balena-cli.md');
 	const [docStat, gitStatus] = await Promise.all([
 		fs.stat(docFile),
 		git.status(),

automation/check-npm-version.js

@@ -6,6 +6,8 @@
  *
  * 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);
@@ -16,6 +18,10 @@ function parseSemver(version) {
 	return [parseInt(major, 10), parseInt(minor, 10), parseInt(patch, 10)];
 }
 
+/**
+ * @param {string} v1
+ * @param {string} v2
+ */
 function semverGte(v1, v2) {
 	let v1Array = parseSemver(v1);
 	let v2Array = parseSemver(v2);
@@ -41,17 +47,25 @@ function checkNpmVersion() {
 		// the reason is that it would unnecessarily prevent end users from
 		// using npm v6.4.1 that ships with Node 8.  (It is OK for the
 		// shrinkwrap file to get damaged if it is not going to be reused.)
-		console.error(`\
--------------------------------------------------------------------------------
+		throw new Error(`\
+-----------------------------------------------------------------------------
 Error: npm version '${npmVersion}' detected. Please upgrade to npm v${requiredVersion} or later
 because of a bug that causes the 'npm-shrinkwrap.json' file to be damaged.
 At this point, however, your 'npm-shrinkwrap.json' file has already been
 damaged. Please revert it to the master branch state with a command such as:
 "git checkout master -- npm-shrinkwrap.json"
 Then re-run "npm install" using npm version ${requiredVersion} or later.
--------------------------------------------------------------------------------`);
-		process.exit(1);
+-----------------------------------------------------------------------------`);
 	}
 }
 
-checkNpmVersion();
+function main() {
+	try {
+		checkNpmVersion();
+	} catch (e) {
+		console.error(e.message || e);
+		process.exitCode = 1;
+	}
+}
+
+main();

automation/deploy-bin.ts

@@ -54,17 +54,18 @@ export async function release() {
 	try {
 		await createGitHubRelease();
 	} catch (err) {
-		console.error('Release failed');
-		console.error(err);
-		process.exit(1);
+		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,
+	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,
@@ -110,7 +111,8 @@ function getPageNumbers(
 	if (!response.headers.link) {
 		return res;
 	}
-	const parse = require('parse-link-header') as typeof import('parse-link-header');
+	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}'`);
@@ -158,11 +160,14 @@ async function updateGitHubReleaseDescriptions(
 		per_page: perPage,
 	});
 	let errCount = 0;
-	for await (const response of octokit.paginate.iterator(options)) {
-		const { page: thisPage, pages: totalPages, ordinal } = getPageNumbers(
-			response,
-			perPage,
-		);
+	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}]`;

automation/run.ts

@@ -27,7 +27,6 @@ import {
 	release,
 	updateDescriptionOfReleasesAffectedByIssue1359,
 } from './deploy-bin';
-import { fixPathForMsys, ROOT, runUnderMsys } from './utils';
 
 // DEBUG set to falsy for negative values else is truthy
 process.env.DEBUG = ['0', 'no', 'false', '', undefined].includes(
@@ -36,11 +35,6 @@ process.env.DEBUG = ['0', 'no', 'false', '', undefined].includes(
 	? ''
 	: '1';
 
-function exitWithError(error: Error | string): never {
-	console.error(`Error: ${error}`);
-	process.exit(1);
-}
-
 /**
  * Trivial command-line parser. Check whether the command-line argument is one
  * of the following strings, then call the appropriate functions:
@@ -48,17 +42,14 @@ function exitWithError(error: Error | string): never {
  * 	   'build:standalone'  (to build a standalone pkg package)
  *     'release'           (to create/update a GitHub release)
  *
- * In the case of 'build:installer', also call runUnderMsys() to switch the
- * shell from cmd.exe to MSYS2 bash.exe.
- *
  * @param args Arguments to parse (default is process.argv.slice(2))
  */
-export async function run(args?: string[]) {
+async function parse(args?: string[]) {
 	args = args || process.argv.slice(2);
-	console.log(`automation/run.ts process.argv=[${process.argv}]\n`);
-	console.log(`automation/run.ts args=[${args}]`);
+	console.error(`[debug] automation/run.ts process.argv=[${process.argv}]`);
+	console.error(`[debug] automation/run.ts args=[${args}]`);
 	if (_.isEmpty(args)) {
-		return exitWithError('missing command-line arguments');
+		throw new Error('missing command-line arguments');
 	}
 	const commands: { [cmd: string]: () => void | Promise<void> } = {
 		'build:installer': buildOclifInstaller,
@@ -70,14 +61,10 @@ export async function run(args?: string[]) {
 	};
 	for (const arg of args) {
 		if (!commands.hasOwnProperty(arg)) {
-			return exitWithError(`command unknown: ${arg}`);
+			throw new Error(`command unknown: ${arg}`);
 		}
 	}
 
-	// If runUnderMsys() is called to re-execute this script under MSYS2,
-	// the current working dir becomes the MSYS2 homedir, so we change back.
-	process.chdir(ROOT);
-
 	// 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
@@ -95,29 +82,26 @@ export async function run(args?: string[]) {
 
 	for (const arg of args) {
 		try {
-			if (arg === 'build:installer' && process.platform === 'win32') {
-				// ensure running under MSYS2
-				if (!process.env.MSYSTEM) {
-					process.env.MSYS2_PATH_TYPE = 'inherit';
-					await runUnderMsys([
-						fixPathForMsys(process.argv[0]),
-						fixPathForMsys(process.argv[1]),
-						arg,
-					]);
-					continue;
-				}
-				if (process.env.MSYS2_PATH_TYPE !== 'inherit') {
-					throw new Error(
-						'the MSYS2_PATH_TYPE env var must be set to "inherit"',
-					);
-				}
-			}
 			const cmdFunc = commands[arg];
 			await cmdFunc();
 		} catch (err) {
-			return exitWithError(`"${arg}": ${err}`);
+			if (typeof err === 'object') {
+				err.message = `"${arg}": ${err.message}`;
+			}
+			throw err;
 		}
 	}
 }
 
+/** See jsdoc for parse() function above */
+export async function run(args?: string[]) {
+	try {
+		await parse(args);
+	} catch (e) {
+		console.error(e.message ? `Error: ${e.message}` : e);
+		process.exitCode = 1;
+	}
+}
+
+// tslint:disable-next-line:no-floating-promises
 run();

automation/test-lock-deduplicated.sh

@@ -10,7 +10,10 @@ npm i
 if ! diff -q npm-shrinkwrap.json npm-shrinkwrap.json.old > /dev/null; then
   rm npm-shrinkwrap.json.old
   echo "** npm-shrinkwrap.json was not deduplicated or not fully committed - FAIL **";
-  echo "** Please run 'npm ci', followed by 'npm dedupe' **";
+  echo "** This can usually be fixed with: **";
+  echo "** git checkout master -- npm-shrinkwrap.json **";
+  echo "** rm -rf node_modules **";
+  echo "** npm install && npm dedupe && npm install **";
   exit 1;
 fi
 

automation/update-module.ts

@@ -11,8 +11,7 @@ const validateChangeType = (maybeChangeType: string = 'minor') => {
 		case 'major':
 			return maybeChangeType;
 		default:
-			console.error(`Invalid change type: '${maybeChangeType}'`);
-			return process.exit(1);
+			throw new Error(`Invalid change type: '${maybeChangeType}'`);
 	}
 };
 
@@ -37,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);
 	});
 };
 
@@ -58,31 +57,24 @@ const getUpstreams = async () => {
 	const repoYaml = fs.readFileSync(__dirname + '/../repo.yml', 'utf8');
 
 	const yaml = await import('js-yaml');
-	const { upstream } = yaml.safeLoad(repoYaml) as {
+	const { upstream } = yaml.load(repoYaml) as {
 		upstream: Upstream[];
 	};
 
 	return upstream;
 };
 
-const printUsage = (upstreams: Upstream[], upstreamName: string) => {
-	console.error(
-		`
+const getUsage = (upstreams: Upstream[], upstreamName: string) => `
 Usage: npm run update ${upstreamName} $version [$changeType=minor]
 
 Upstream names: ${upstreams.map(({ repo }) => repo).join(', ')}
-`,
-	);
-	return process.exit(1);
-};
+`;
 
-// TODO: Drop the wrapper function once we move to TS 3.8,
-// which will support top level await.
-async function main() {
+async function $main() {
 	const upstreams = await getUpstreams();
 
 	if (process.argv.length < 3) {
-		return printUsage(upstreams, '$upstreamName');
+		throw new Error(getUsage(upstreams, '$upstreamName'));
 	}
 
 	const upstreamName = process.argv[2];
@@ -90,16 +82,15 @@ async function main() {
 	const upstream = upstreams.find((v) => v.repo === upstreamName);
 
 	if (!upstream) {
-		console.error(
+		throw new Error(
 			`Invalid upstream name '${upstreamName}', valid options: ${upstreams
 				.map(({ repo }) => repo)
 				.join(', ')}`,
 		);
-		return process.exit(1);
 	}
 
 	if (process.argv.length < 4) {
-		printUsage(upstreams, upstreamName);
+		throw new Error(getUsage(upstreams, upstreamName));
 	}
 
 	const packageName = upstream.module || upstream.repo;
@@ -108,8 +99,7 @@ async function main() {
 	await run(`npm install ${packageName}@${process.argv[3]}`);
 	const newVersion = await getVersion(packageName);
 	if (newVersion === oldVersion) {
-		console.error(`Already on version '${newVersion}'`);
-		return process.exit(1);
+		throw new Error(`Already on version '${newVersion}'`);
 	}
 
 	console.log(`Updated ${upstreamName} from ${oldVersion} to ${newVersion}`);
@@ -137,4 +127,14 @@ async function main() {
 	);
 }
 
+async function main() {
+	try {
+		await $main();
+	} catch (e) {
+		console.error(e);
+		process.exitCode = 1;
+	}
+}
+
+// tslint:disable-next-line:no-floating-promises
 main();

automation/utils.ts

@@ -18,9 +18,7 @@
 import { spawn } from 'child_process';
 import * as _ from 'lodash';
 import * as path from 'path';
-import * as shellEscape from 'shell-escape';
 
-export const MSYS2_BASH = 'C:\\msys64\\usr\\bin\\bash.exe';
 export const ROOT = path.join(__dirname, '..');
 
 /** Tap and buffer this process' stdout and stderr */
@@ -90,93 +88,6 @@ export function loadPackageJson() {
 	return require(path.join(ROOT, 'package.json'));
 }
 
-/**
- * Convert e.g. 'C:\myfolder' -> '/C/myfolder' so that the path can be given
- * as argument to "unix tools" like 'tar' under MSYS or MSYS2 on Windows.
- */
-export function fixPathForMsys(p: string): string {
-	return p.replace(/\\/g, '/').replace(/^([a-zA-Z]):/, '/$1');
-}
-
-/**
- * Run the MSYS2 bash.exe shell in a child process (child_process.spawn()).
- * The given argv arguments are escaped using the 'shell-escape' package,
- * so that backslashes in Windows paths, and other bash-special characters,
- * are preserved. If argv is not provided, defaults to process.argv, to the
- * effect that this current (parent) process is re-executed under MSYS2 bash.
- * This is useful to change the default shell from cmd.exe to MSYS2 bash on
- * Windows.
- * @param argv Arguments to be shell-escaped and given to MSYS2 bash.exe.
- */
-export async function runUnderMsys(argv?: string[]) {
-	const newArgv = argv || process.argv;
-	await new Promise((resolve, reject) => {
-		const args = ['-lc', shellEscape(newArgv)];
-		const child = spawn(MSYS2_BASH, args, { stdio: 'inherit' });
-		child.on('close', (code) => {
-			if (code) {
-				console.log(`runUnderMsys: child process exited with code ${code}`);
-				reject(code);
-			} else {
-				resolve();
-			}
-		});
-	});
-}
-
-/**
- * Run the executable at execPath as a child process, and resolve a promise
- * to the executable's stdout output as a string. Reject the promise if
- * anything is printed to stderr, or if the child process exits with a
- * non-zero exit code.
- * @param execPath Executable path
- * @param args Command-line argument for the executable
- */
-export async function getSubprocessStdout(
-	execPath: string,
-	args: string[],
-): Promise<string> {
-	const child = spawn(execPath, args);
-	return new Promise((resolve, reject) => {
-		let stdout = '';
-		child.stdout.on('error', reject);
-		child.stderr.on('error', reject);
-		child.stdout.on('data', (data: Buffer) => {
-			try {
-				stdout = data.toString();
-			} catch (err) {
-				reject(err);
-			}
-		});
-		child.stderr.on('data', (data: Buffer) => {
-			try {
-				const stderr = data.toString();
-
-				// ignore any debug lines, but ensure that we parse
-				// every line provided to the stderr stream
-				const lines = _.filter(
-					stderr.trim().split(/\r?\n/),
-					(line) => !line.startsWith('[debug]'),
-				);
-				if (lines.length > 0) {
-					reject(
-						new Error(`"${execPath}": non-empty stderr "${lines.join('\n')}"`),
-					);
-				}
-			} catch (err) {
-				reject(err);
-			}
-		});
-		child.on('exit', (code: number) => {
-			if (code) {
-				reject(new Error(`"${execPath}": non-zero exit code "${code}"`));
-			} else {
-				resolve(stdout);
-			}
-		});
-	});
-}
-
 /**
  * Error handling wrapper around the npm `which` package:
  * "Like the unix which utility. Finds the first instance of a specified
@@ -206,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;

balena-completion.bash

@@ -1,73 +0,0 @@
-#!/bin/bash
-
-_balena_complete()
-{
-  local cur prev
-
-  # Valid top-level completions
-  commands="app apps build config deploy device devices env envs help key \
-            keys local login logout logs note os preload quickstart settings \
-            scan ssh util version whoami"
-  # Sub-completions
-  app_cmds="create restart rm"
-  config_cmds="generate inject read reconfigure write"
-  device_cmds="identify init move public-url reboot register rename rm \
-               shutdown"
-  device_public_url_cmds="disable enable status"
-  env_cmds="add rename rm"
-  key_cmds="add rm"
-  local_cmds="configure flash"
-  os_cmds="build-config configure download initialize versions"
-  util_cmds="available-drives"
-
-
-  COMPREPLY=()
-  cur=${COMP_WORDS[COMP_CWORD]}
-  prev=${COMP_WORDS[COMP_CWORD-1]}
-
-  if [ $COMP_CWORD -eq 1 ]
-  then
-    COMPREPLY=( $(compgen -W "${commands}" -- $cur) )
-  elif [ $COMP_CWORD -eq 2 ]
-  then
-    case "$prev" in
-      "app")
-        COMPREPLY=( $(compgen -W "$app_cmds" -- $cur) )
-        ;;
-      "config")
-        COMPREPLY=( $(compgen -W "$config_cmds" -- $cur) )
-        ;;
-      "device")
-        COMPREPLY=( $(compgen -W "$device_cmds" -- $cur) )
-        ;;
-      "env")
-        COMPREPLY=( $(compgen -W "$env_cmds" -- $cur) )
-        ;;
-      "key")
-        COMPREPLY=( $(compgen -W "$key_cmds" -- $cur) )
-        ;;
-      "local")
-        COMPREPLY=( $(compgen -W "$local_cmds" -- $cur) )
-        ;;
-      "os")
-        COMPREPLY=( $(compgen -W "$os_cmds" -- $cur) )
-        ;;
-      "util")
-        COMPREPLY=( $(compgen -W "$util_cmds" -- $cur) )
-        ;;
-      "*")
-        ;;
-    esac
-  elif [ $COMP_CWORD -eq 3 ]
-  then
-    case "$prev" in
-      "public-url")
-        COMPREPLY=( $(compgen -W "$device_public_url_cmds" -- $cur) )
-        ;;
-      "*")
-        ;;
-    esac
-  fi
-
-}
-complete -F _balena_complete balena

bin/balena

@@ -1,5 +1,7 @@
 #!/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';
@@ -7,14 +9,15 @@ process.env.UV_THREADPOOL_SIZE = '64';
 // Disable oclif registering ts-node
 process.env.OCLIF_TS_NODE = 0;
 
-// Use fast-boot to cache require lookups, speeding up startup
-require('fast-boot2').start({
-	cacheScope: __dirname + '/..',
-	cacheFile: __dirname + '/.fast-boot.json'
-});
+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');
+	// Set the desired es version for downstream modules that support it
+	require('@balena/es-version').set('es2018');
 
-// Run the CLI
-require('../build/app').run();
+	// Run the CLI
+	await require('../build/app').run();
+}
+
+run();

bin/balena-dev

@@ -1,25 +1,55 @@
 #!/usr/bin/env node
 
 // ****************************************************************************
-// THIS IS FOR DEV PERROSES ONLY AND WILL NOT BE PART OF THE PUBLISHED PACKAGE
+// 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';
 
-// Use fast-boot to cache require lookups, speeding up startup
-require('fast-boot2').start({
-	cacheScope: __dirname + '/..',
-	cacheFile: '.fast-boot.json',
+// 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');
 
-const path = require('path');
-const rootDir = path.join(__dirname, '..');
 // 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,
@@ -30,3 +60,30 @@ require('ts-node').register({
 	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',
+	);
+}

completion/_balena

@@ -0,0 +1,83 @@
+#compdef balena
+#autoload
+
+#GENERATED FILE DON'T MODIFY#
+
+_balena() {
+  typeset -A opt_args
+  local context state line curcontext="$curcontext"
+
+  # Valid top-level completions
+  main_commands=( 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 config device device devices env fleet fleet internal key key local os release release tag util )
+  # Sub-completions
+  api_key_cmds=( generate )
+  config_cmds=( generate inject read reconfigure write )
+  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 )
+  os_cmds=( build-config configure download initialize versions )
+  release_cmds=( finalize )
+  tag_cmds=( rm set )
+
+
+  _arguments -C \
+    '(- 1 *)--version[show version and exit]' \
+    '(- 1 *)'{-h,--help}'[show help options and exit]' \
+    '1:first command:_balena_main_cmds' \
+    '2:second command:_balena_sec_cmds' \
+  && ret=0
+}
+
+(( $+functions[_balena_main_cmds] )) ||
+_balena_main_cmds() {
+  _describe -t main_commands 'command' main_commands "$@" && ret=0
+}
+
+(( $+functions[_balena_sec_cmds] )) ||
+_balena_sec_cmds() {
+  case $line[1] in
+      "api-key")
+        _describe -t api_key_cmds 'api-key_cmd' api_key_cmds "$@" && ret=0
+      ;;
+      "config")
+        _describe -t config_cmds 'config_cmd' config_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
+      ;;
+      "fleet")
+        _describe -t fleet_cmds 'fleet_cmd' fleet_cmds "$@" && ret=0
+      ;;
+      "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
+      ;;
+      "os")
+        _describe -t os_cmds 'os_cmd' os_cmds "$@" && ret=0
+      ;;
+      "release")
+        _describe -t release_cmds 'release_cmd' release_cmds "$@" && ret=0
+      ;;
+      "tag")
+        _describe -t tag_cmds 'tag_cmd' tag_cmds "$@" && ret=0
+      ;;
+
+  esac
+}
+
+_balena "$@"

completion/balena-completion.bash

@@ -0,0 +1,80 @@
+#!/bin/bash
+
+#GENERATED FILE DON'T MODIFY#
+
+_balena_complete()
+{
+  local cur prev
+
+  # Valid top-level completions
+  main_commands="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 config device device devices env fleet fleet internal key key local os release release tag util"
+  # Sub-completions
+  api_key_cmds="generate"
+  config_cmds="generate inject read reconfigure write"
+  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"
+  os_cmds="build-config configure download initialize versions"
+  release_cmds="finalize"
+  tag_cmds="rm set"
+
+
+
+  COMPREPLY=()
+  cur=${COMP_WORDS[COMP_CWORD]}
+  prev=${COMP_WORDS[COMP_CWORD-1]}
+
+  if [ $COMP_CWORD -eq 1 ]
+  then
+    COMPREPLY=( $(compgen -W "${main_commands}" -- $cur) )
+  elif [ $COMP_CWORD -eq 2 ]
+  then
+    case "$prev" in
+      api-key)
+        COMPREPLY=( $(compgen -W "$api_key_cmds" -- $cur) )
+        ;;
+      config)
+        COMPREPLY=( $(compgen -W "$config_cmds" -- $cur) )
+        ;;
+      device)
+        COMPREPLY=( $(compgen -W "$device_cmds" -- $cur) )
+        ;;
+      devices)
+        COMPREPLY=( $(compgen -W "$devices_cmds" -- $cur) )
+        ;;
+      env)
+        COMPREPLY=( $(compgen -W "$env_cmds" -- $cur) )
+        ;;
+      fleet)
+        COMPREPLY=( $(compgen -W "$fleet_cmds" -- $cur) )
+        ;;
+      internal)
+        COMPREPLY=( $(compgen -W "$internal_cmds" -- $cur) )
+        ;;
+      key)
+        COMPREPLY=( $(compgen -W "$key_cmds" -- $cur) )
+        ;;
+      local)
+        COMPREPLY=( $(compgen -W "$local_cmds" -- $cur) )
+        ;;
+      os)
+        COMPREPLY=( $(compgen -W "$os_cmds" -- $cur) )
+        ;;
+      release)
+        COMPREPLY=( $(compgen -W "$release_cmds" -- $cur) )
+        ;;
+      tag)
+        COMPREPLY=( $(compgen -W "$tag_cmds" -- $cur) )
+        ;;
+
+      "*")
+        ;;
+    esac
+  fi
+
+}
+complete -F _balena_complete balena

completion/generate-completion.js

@@ -0,0 +1,175 @@
+/**
+ * @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.
+ */
+
+const path = require('path');
+const rootDir = path.join(__dirname, '..');
+const fs = require('fs');
+const manifestFile = 'oclif.manifest.json';
+
+commandsFilePath = path.join(rootDir, manifestFile);
+if (fs.existsSync(commandsFilePath)) {
+	console.log('Generating shell auto completion files...');
+} else {
+	console.error(`generate-completion.js: Could not find "${manifestFile}"`);
+	process.exitCode = 1;
+	return;
+}
+
+const commandsJson = JSON.parse(fs.readFileSync(commandsFilePath, 'utf8'));
+
+var mainCommands = [];
+var additionalCommands = [];
+for (const key of Object.keys(commandsJson.commands)) {
+	const cmd = key.split(':');
+	if (cmd.length > 1) {
+		additionalCommands.push(cmd);
+		if (!mainCommands.includes(cmd[0])) {
+			mainCommands.push(cmd[0]);
+		}
+	} else {
+		mainCommands.push(cmd[0]);
+	}
+}
+const mainCommandsStr = mainCommands.join(' ');
+
+// GENERATE BASH COMPLETION FILE
+bashFilePathIn = path.join(__dirname, '/templates/bash.template');
+bashFilePathOut = path.join(__dirname, 'balena-completion.bash');
+
+try {
+	fs.unlinkSync(bashFilePathOut);
+} catch (error) {
+	process.exitCode = 1;
+	return console.error(error);
+}
+
+fs.readFile(bashFilePathIn, 'utf8', function (err, data) {
+	if (err) {
+		process.exitCode = 1;
+		return console.error(err);
+	}
+
+	data = data.replace(
+		'#TEMPLATE FILE FOR BASH COMPLETION#',
+		"#GENERATED FILE DON'T MODIFY#",
+	);
+
+	data = data.replace(
+		/\$main_commands\$/g,
+		'main_commands="' + mainCommandsStr + '"',
+	);
+	var subCommands = [];
+	var prevElement = additionalCommands[0][0];
+	additionalCommands.forEach(function (element) {
+		if (element[0] === prevElement) {
+			subCommands.push(element[1]);
+		} else {
+			const prevElement2 = prevElement.replace(/-/g, '_') + '_cmds';
+			data = data.replace(
+				/\$sub_cmds\$/g,
+				'  ' + prevElement2 + '="' + subCommands.join(' ') + '"\n$sub_cmds$',
+			);
+			data = data.replace(
+				/\$sub_cmds_prev\$/g,
+				'      ' +
+					prevElement +
+					')\n        COMPREPLY=( $(compgen -W "$' +
+					prevElement2 +
+					'" -- $cur) )\n        ;;\n$sub_cmds_prev$',
+			);
+			prevElement = element[0];
+			subCommands = [];
+			subCommands.push(element[1]);
+		}
+	});
+	// cleanup placeholders
+	data = data.replace(/\$sub_cmds\$/g, '');
+	data = data.replace(/\$sub_cmds_prev\$/g, '');
+
+	fs.writeFile(bashFilePathOut, data, 'utf8', function (error) {
+		if (error) {
+			process.exitCode = 1;
+			return console.error(error);
+		}
+	});
+});
+
+// GENERATE ZSH COMPLETION FILE
+zshFilePathIn = path.join(__dirname, '/templates/zsh.template');
+zshFilePathOut = path.join(__dirname, '_balena');
+
+try {
+	fs.unlinkSync(zshFilePathOut);
+} catch (error) {
+	process.exitCode = 1;
+	return console.error(error);
+}
+
+fs.readFile(zshFilePathIn, 'utf8', function (err, data) {
+	if (err) {
+		process.exitCode = 1;
+		return console.error(err);
+	}
+
+	data = data.replace(
+		'#TEMPLATE FILE FOR ZSH COMPLETION#',
+		"#GENERATED FILE DON'T MODIFY#",
+	);
+
+	data = data.replace(
+		/\$main_commands\$/g,
+		'main_commands=( ' + mainCommandsStr + ' )',
+	);
+	var subCommands = [];
+	var prevElement = additionalCommands[0][0];
+	additionalCommands.forEach(function (element) {
+		if (element[0] === prevElement) {
+			subCommands.push(element[1]);
+		} else {
+			const prevElement2 = prevElement.replace(/-/g, '_') + '_cmds';
+			data = data.replace(
+				/\$sub_cmds\$/g,
+				'  ' + prevElement2 + '=( ' + subCommands.join(' ') + ' )\n$sub_cmds$',
+			);
+			data = data.replace(
+				/\$sub_cmds_prev\$/g,
+				'      "' +
+					prevElement +
+					'")\n        _describe -t ' +
+					prevElement2 +
+					" '" +
+					prevElement +
+					"_cmd' " +
+					prevElement2 +
+					' "$@" && ret=0\n      ;;\n$sub_cmds_prev$',
+			);
+			prevElement = element[0];
+			subCommands = [];
+			subCommands.push(element[1]);
+		}
+	});
+	// cleanup placeholders
+	data = data.replace(/\$sub_cmds\$/g, '');
+	data = data.replace(/\$sub_cmds_prev\$/g, '');
+
+	fs.writeFile(zshFilePathOut, data, 'utf8', function (error) {
+		if (error) {
+			process.exitCode = 1;
+			return console.error(error);
+		}
+	});
+});

completion/templates/bash.template

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+#TEMPLATE FILE FOR BASH COMPLETION#
+
+_balena_complete()
+{
+  local cur prev
+
+  # Valid top-level completions
+  $main_commands$
+  # Sub-completions
+$sub_cmds$
+
+
+  COMPREPLY=()
+  cur=${COMP_WORDS[COMP_CWORD]}
+  prev=${COMP_WORDS[COMP_CWORD-1]}
+
+  if [ $COMP_CWORD -eq 1 ]
+  then
+    COMPREPLY=( $(compgen -W "${main_commands}" -- $cur) )
+  elif [ $COMP_CWORD -eq 2 ]
+  then
+    case "$prev" in
+$sub_cmds_prev$
+      "*")
+        ;;
+    esac
+  fi
+
+}
+complete -F _balena_complete balena

completion/templates/zsh.template

@@ -0,0 +1,35 @@
+#compdef balena
+#autoload
+
+#TEMPLATE FILE FOR ZSH COMPLETION#
+
+_balena() {
+  typeset -A opt_args
+  local context state line curcontext="$curcontext"
+
+  # Valid top-level completions
+  $main_commands$
+  # Sub-completions
+$sub_cmds$
+
+  _arguments -C \
+    '(- 1 *)--version[show version and exit]' \
+    '(- 1 *)'{-h,--help}'[show help options and exit]' \
+    '1:first command:_balena_main_cmds' \
+    '2:second command:_balena_sec_cmds' \
+  && ret=0
+}
+
+(( $+functions[_balena_main_cmds] )) ||
+_balena_main_cmds() {
+  _describe -t main_commands 'command' main_commands "$@" && ret=0
+}
+
+(( $+functions[_balena_sec_cmds] )) ||
+_balena_sec_cmds() {
+  case $line[1] in
+$sub_cmds_prev$
+  esac
+}
+
+_balena "$@"

doc/automated-init.md

@@ -1,112 +0,0 @@
-# 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 --app APP_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. `APP_ID`. Create an application (`balena app create APP_NAME --type DEVICE_TYPE`) or find an existing one (`balena apps`) 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.

gulpfile.js

@@ -1,15 +0,0 @@
-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/actions-oclif/app/create.ts

@@ -1,104 +0,0 @@
-/**
- * @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';
-import type * as BalenaSDK from 'balena-sdk';
-
-interface FlagsDef {
-	type?: string; // application device type
-	help: void;
-}
-
-interface ArgsDef {
-	name: string;
-}
-
-export default class AppCreateCmd extends Command {
-	public static description = stripIndent`
-		Create an application.
-
-		Create a new balena application.
-
-		You can specify the application device type with the \`--type\` option.
-		Otherwise, an interactive dropdown will be shown for you to select from.
-
-		You can see a list of supported device types with:
-
-		$ balena devices supported
-`;
-	public static examples = [
-		'$ balena app create MyApp',
-		'$ balena app create MyApp --type raspberry-pi',
-	];
-
-	public static args = [
-		{
-			name: 'name',
-			description: 'application name',
-			required: true,
-		},
-	];
-
-	public static usage = 'app create <name>';
-
-	public static flags: flags.Input<FlagsDef> = {
-		type: flags.string({
-			char: 't',
-			description:
-				'application device type (Check available types with `balena devices supported`)',
-		}),
-		help: cf.help,
-	};
-
-	public static authenticated = true;
-
-	public async run() {
-		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
-			AppCreateCmd,
-		);
-
-		const balena = getBalenaSdk();
-
-		// Create application
-		const deviceType =
-			options.type ||
-			(await (await import('../../utils/patterns')).selectDeviceType());
-		let application: BalenaSDK.Application;
-		try {
-			application = await balena.models.application.create({
-				name: params.name,
-				deviceType,
-				organization: (await balena.auth.whoami())!,
-			});
-		} catch (err) {
-			// BalenaRequestError: Request error: Unique key constraint violated
-			if ((err.message || '').toLowerCase().includes('unique')) {
-				throw new ExpectedError(
-					`Error: application "${params.name}" already exists`,
-				);
-			}
-			throw err;
-		}
-		console.info(
-			`Application created: ${application.slug} (${deviceType}, id ${application.id})`,
-		);
-	}
-}

lib/actions-oclif/app/index.ts

@@ -1,87 +0,0 @@
-/**
- * @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 { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
-import { tryAsInteger } from '../../utils/validation';
-import { Release } from 'balena-sdk';
-
-interface FlagsDef {
-	help: void;
-}
-
-interface ArgsDef {
-	name: string;
-}
-
-export default class AppCmd extends Command {
-	public static description = stripIndent`
-		Display information about a single application.
-
-		Display detailed information about a single balena application.
-`;
-	public static examples = ['$ balena app MyApp'];
-
-	public static args = [
-		{
-			name: 'name',
-			description: 'application name or numeric ID',
-			required: true,
-		},
-	];
-
-	public static usage = 'app <name>';
-
-	public static flags: flags.Input<FlagsDef> = {
-		help: cf.help,
-	};
-
-	public static authenticated = true;
-	public static primary = true;
-
-	public async run() {
-		const { args: params } = this.parse<FlagsDef, ArgsDef>(AppCmd);
-
-		const application = (await getBalenaSdk().models.application.get(
-			tryAsInteger(params.name),
-			{
-				$expand: {
-					is_for__device_type: { $select: 'slug' },
-					should_be_running__release: { $select: 'commit' },
-				},
-			},
-		)) as ApplicationWithDeviceType & {
-			should_be_running__release: [Release?];
-		};
-
-		// @ts-expect-error
-		application.device_type = application.is_for__device_type[0].slug;
-		// @ts-expect-error
-		application.commit = application.should_be_running__release[0]?.commit;
-		console.log(
-			getVisuals().table.vertical(application, [
-				`$${application.app_name}$`,
-				'id',
-				'device_type',
-				'slug',
-				'commit',
-			]),
-		);
-	}
-}

lib/actions-oclif/apps.ts

@@ -1,97 +0,0 @@
-/**
- * @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 { getBalenaSdk, getVisuals, stripIndent } from '../utils/lazy';
-import { isV12 } from '../utils/version';
-
-interface ExtendedApplication extends ApplicationWithDeviceType {
-	device_count?: number;
-	online_devices?: number;
-}
-
-interface FlagsDef {
-	help: void;
-	verbose?: boolean;
-}
-
-export default class AppsCmd extends Command {
-	public static description = stripIndent`
-		List all applications.
-
-		list all your balena applications.
-
-		For detailed information on a particular application,
-		use \`balena app <name> instead\`.
-`;
-	public static examples = ['$ balena apps'];
-
-	public static usage = 'apps';
-
-	public static flags: flags.Input<FlagsDef> = {
-		help: cf.help,
-		verbose: flags.boolean({
-			char: 'v',
-			description: isV12()
-				? 'No-op since release v12.0.0'
-				: 'add extra columns in the tabular output (SLUG)',
-		}),
-	};
-
-	public static authenticated = true;
-	public static primary = true;
-
-	public async run() {
-		const { flags: options } = this.parse<FlagsDef, {}>(AppsCmd);
-
-		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',
-				'app_name',
-				options.verbose || isV12() ? 'slug' : '',
-				'device_type',
-				'online_devices',
-				'device_count',
-			]),
-		);
-	}
-}

lib/actions-oclif/device/move.ts

@@ -1,165 +0,0 @@
-/**
- * @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 type { Application } from 'balena-sdk';
-import Command from '../../command';
-import * as cf from '../../utils/common-flags';
-import { expandForAppName } from '../../utils/helpers';
-import { getBalenaSdk, stripIndent } from '../../utils/lazy';
-import { tryAsInteger } from '../../utils/validation';
-import { ExpectedError } from '../../errors';
-
-interface ExtendedDevice extends DeviceWithDeviceType {
-	application_name?: string;
-}
-
-interface FlagsDef {
-	application?: string;
-	app?: string;
-	help: void;
-}
-
-interface ArgsDef {
-	uuid: string;
-}
-
-export default class DeviceMoveCmd extends Command {
-	public static description = stripIndent`
-		Move one or more devices to another application.
-
-		Move one or more devices to another application.
-
-		Note, if the application option is omitted it will be prompted
-		for interactively.
-		`;
-	public static examples = [
-		'$ balena device move 7cf02a6',
-		'$ balena device move 7cf02a6,dc39e52',
-		'$ balena device move 7cf02a6 --application MyNewApp',
-	];
-
-	public static args: Array<IArg<any>> = [
-		{
-			name: 'uuid',
-			description:
-				'comma-separated list (no blank spaces) of device UUIDs to be moved',
-			parse: (dev) => tryAsInteger(dev),
-			required: true,
-		},
-	];
-
-	public static usage = 'device move <uuid(s)>';
-
-	public static flags: flags.Input<FlagsDef> = {
-		application: cf.application,
-		app: cf.app,
-		help: cf.help,
-	};
-
-	public static authenticated = true;
-
-	public async run() {
-		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
-			DeviceMoveCmd,
-		);
-
-		const balena = getBalenaSdk();
-
-		// Consolidate application options
-		options.application = options.application || options.app;
-		delete options.app;
-
-		const devices = await Promise.all(
-			params.uuid
-				.split(',')
-				.map(
-					(uuid) =>
-						balena.models.device.get(uuid, expandForAppName) as Promise<
-							ExtendedDevice
-						>,
-				),
-		);
-
-		for (const device of devices) {
-			const belongsToApplication = device.belongs_to__application as Application[];
-			device.application_name = belongsToApplication?.[0]
-				? belongsToApplication[0].app_name
-				: 'N/a';
-		}
-
-		// Get destination application
-		let application;
-		if (options.application) {
-			application = options.application;
-		} else {
-			const [deviceDeviceTypes, deviceTypes] = await Promise.all([
-				Promise.all(
-					devices.map((device) =>
-						balena.models.device.getManifestBySlug(
-							device.is_of__device_type[0].slug,
-						),
-					),
-				),
-				balena.models.config.getDeviceTypes(),
-			]);
-
-			const compatibleDeviceTypes = deviceTypes.filter((dt) =>
-				deviceDeviceTypes.every(
-					(deviceDeviceType) =>
-						balena.models.os.isArchitectureCompatibleWith(
-							deviceDeviceType.arch,
-							dt.arch,
-						) &&
-						!!dt.isDependent === !!deviceDeviceType.isDependent &&
-						dt.state !== 'DISCONTINUED',
-				),
-			);
-
-			const patterns = await import('../../utils/patterns');
-			try {
-				application = await patterns.selectApplication(
-					(app) =>
-						compatibleDeviceTypes.some(
-							(dt) => dt.slug === app.is_for__device_type[0].slug,
-						) &&
-						// @ts-ignore using the extended device object prop
-						devices.some((device) => device.application_name !== app.app_name),
-					true,
-				);
-			} catch (err) {
-				if (deviceDeviceTypes.length) {
-					throw new ExpectedError(
-						`${err.message}\nDo all devices have a compatible architecture?`,
-					);
-				}
-				throw err;
-			}
-		}
-
-		for (const uuid of params.uuid.split(',')) {
-			try {
-				await balena.models.device.move(uuid, tryAsInteger(application));
-				console.info(`${uuid} was moved to ${application}`);
-			} catch (err) {
-				console.info(`${err.message}, uuid: ${uuid}`);
-				process.exitCode = 1;
-			}
-		}
-	}
-}

lib/actions-oclif/envs.ts

@@ -1,442 +0,0 @@
-/**
- * @license
- * Copyright 2016-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 { flags } from '@oclif/command';
-import type * as SDK from 'balena-sdk';
-import * as _ from 'lodash';
-import Command from '../command';
-
-import { ExpectedError } from '../errors';
-import * as cf from '../utils/common-flags';
-import { getBalenaSdk, getVisuals, stripIndent } from '../utils/lazy';
-import { CommandHelp } from '../utils/oclif-utils';
-import { isV12 } from '../utils/version';
-
-interface FlagsDef {
-	all?: boolean; // whether to include application-wide, device-wide variables //TODO: REMOVE
-	application?: string; // application name
-	config: boolean;
-	device?: string; // device UUID
-	json: boolean;
-	help: void;
-	service?: string; // service name
-	verbose: boolean;
-}
-
-interface EnvironmentVariableInfo extends SDK.EnvironmentVariableBase {
-	appName?: string | null; // application name
-	deviceUUID?: string; // device UUID
-	serviceName?: string; // service name
-}
-
-interface DeviceServiceEnvironmentVariableInfo
-	extends SDK.DeviceServiceEnvironmentVariable {
-	appName?: string; // application name
-	deviceUUID?: string; // device UUID
-	serviceName?: string; // service name
-}
-
-interface ServiceEnvironmentVariableInfo
-	extends SDK.ServiceEnvironmentVariable {
-	appName?: string; // application name
-	deviceUUID?: string; // device UUID
-	serviceName?: string; // service name
-}
-
-export default class EnvsCmd extends Command {
-	public static description = isV12()
-		? stripIndent`
-		List the environment or config variables of an application, device or service.
-
-		List the environment or configuration variables of an application, device or
-		service, as selected by the respective command-line options. (A service is
-		an application container in a "microservices" application.)
-
-		The results include application-wide (fleet), device-wide (multiple services on
-		a device) and service-specific variables that apply to the selected application,
-		device or service. It can be thought of as including "inherited" variables;
-		for example, a service inherits device-wide variables, and a device inherits
-		application-wide variables.
-
-		The printed output may include DEVICE and/or SERVICE columns to distinguish
-		between application-wide, device-specific and service-specific variables.
-		An asterisk in these columns indicates that the variable applies to
-		"all devices" or "all services".
-
-		The --config option is used to list "configuration variables" that control
-		balena platform features, as opposed to custom environment variables defined
-		by the user. The --config and the --service options are mutually exclusive
-		because configuration variables cannot be set for specific services.
-
-		The --json option is recommended when scripting the output of this command,
-		because the JSON format is less likely to change and it better represents data
-		types like lists and empty strings. The 'jq' utility may be helpful in shell
-		scripts (https://stedolan.github.io/jq/manual/). When --json is used, an empty
-		JSON array ([]) is printed instead of an error message when no variables exist
-		for the given query. When querying variables for a device, note that the
-		application name may be null in JSON output (or 'N/A' in tabular output) if the
-		application linked to the device is no longer accessible by the current user
-		(for example, in case the current user has been removed from the application
-		by its owner).
-`
-		: stripIndent`
-		List the environment or config variables of an application, device or service.
-
-		List the environment or configuration variables of an application, device or
-		service, as selected by the respective command-line options. (A service is
-		an application container in a "microservices" application.)
-
-		The --config option is used to list "configuration variables" that control
-		balena platform features, as opposed to custom environment variables defined
-		by the user. The --config and the --service options are mutually exclusive
-		because configuration variables cannot be set for specific services.
-
-		The --all option is used to include application-wide (fleet), device-wide
-		(multiple services on a device) and service-specific variables that apply to
-		the selected application, device or service. It can be thought of as including
-		"inherited" variables: for example, a service inherits device-wide variables,
-		and a device inherits application-wide variables. Variables are still filtered
-		out by type with the --config option, such that configuration and non-
-		configuration variables are never listed together.
-
-		When the --all option is used, the printed output may include DEVICE and/or
-		SERVICE columns to distinguish between application-wide, device-specific and
-		service-specific variables. An asterisk in these columns indicates that the
-		variable applies to "all devices" or "all services".
-
-		The --json option is recommended when scripting the output of this command,
-		because the JSON format is less likely to change and it better represents data
-		types like lists and empty strings. The 'jq' utility may be helpful in shell
-		scripts (https://stedolan.github.io/jq/manual/). When --json is used, an empty
-		JSON array ([]) is printed instead of an error message when no variables exist
-		for the given query. When querying variables for a device, note that the
-		application name may be null in JSON output (or 'N/A' in tabular output) if the
-		application linked to the device is no longer accessible by the current user
-		(for example, in case the current user has been removed from the application
-		by its owner).
-`;
-	public static examples = isV12()
-		? [
-				'$ balena envs --application MyApp',
-				'$ balena envs --application MyApp --json',
-				'$ balena envs --application MyApp --service MyService',
-				'$ balena envs --application MyApp --service MyService',
-				'$ balena envs --application MyApp --config',
-				'$ balena envs --device 7cf02a6',
-				'$ balena envs --device 7cf02a6 --json',
-				'$ balena envs --device 7cf02a6 --config --json',
-				'$ balena envs --device 7cf02a6 --service MyService',
-		  ]
-		: [
-				'$ balena envs --application MyApp',
-				'$ balena envs --application MyApp --all --json',
-				'$ balena envs --application MyApp --service MyService',
-				'$ balena envs --application MyApp --all --service MyService',
-				'$ balena envs --application MyApp --config',
-				'$ balena envs --device 7cf02a6',
-				'$ balena envs --device 7cf02a6 --all --json',
-				'$ balena envs --device 7cf02a6 --config --all --json',
-				'$ balena envs --device 7cf02a6 --all --service MyService',
-		  ];
-
-	public static usage = (
-		'envs ' + new CommandHelp({ args: EnvsCmd.args }).defaultUsage()
-	).trim();
-
-	public static flags: flags.Input<FlagsDef> = {
-		...(isV12()
-			? {
-					all: flags.boolean({
-						description: stripIndent`
-				No-op since balena CLI v12.0.0.`,
-						hidden: true,
-					}),
-			  }
-			: {
-					all: flags.boolean({
-						description: stripIndent`
-				include app-wide, device-wide variables that apply to the selected device or service.
-				Variables are still filtered out by type with the --config option.`,
-					}),
-			  }),
-		application: { exclusive: ['device'], ...cf.application },
-		config: flags.boolean({
-			char: 'c',
-			description: 'show configuration variables only',
-			exclusive: ['service'],
-		}),
-		device: { exclusive: ['application'], ...cf.device },
-		help: cf.help,
-		json: flags.boolean({
-			char: 'j',
-			description: 'produce JSON output instead of tabular output',
-		}),
-		verbose: cf.verbose,
-		service: { exclusive: ['config'], ...cf.service },
-	};
-
-	public async run() {
-		const { flags: options } = this.parse<FlagsDef, {}>(EnvsCmd);
-		const variables: EnvironmentVariableInfo[] = [];
-
-		options.all = options.all || isV12();
-
-		await Command.checkLoggedIn();
-
-		if (!options.application && !options.device) {
-			throw new ExpectedError('You must specify an application or device');
-		}
-
-		const balena = getBalenaSdk();
-
-		let appName = options.application;
-		let fullUUID: string | undefined; // as oppposed to the short, 7-char UUID
-
-		if (options.device) {
-			const { getDeviceAndMaybeAppFromUUID } = await import('../utils/cloud');
-			const [device, app] = await getDeviceAndMaybeAppFromUUID(
-				balena,
-				options.device,
-				['uuid'],
-				['app_name'],
-			);
-			fullUUID = device.uuid;
-			if (app) {
-				appName = app.app_name;
-			}
-		}
-		if (appName && options.service) {
-			await validateServiceName(balena, options.service, appName);
-		}
-		if (options.application || options.all) {
-			variables.push(...(await getAppVars(balena, appName, options)));
-		}
-		if (fullUUID) {
-			variables.push(
-				...(await getDeviceVars(balena, fullUUID, appName, options)),
-			);
-		}
-		if (!options.json && variables.length === 0) {
-			const target =
-				(options.service ? `service "${options.service}" of ` : '') +
-				(options.application
-					? `application "${options.application}"`
-					: `device "${options.device}"`);
-			throw new ExpectedError(`No environment variables found for ${target}`);
-		}
-
-		await this.printVariables(variables, options);
-	}
-
-	protected async printVariables(
-		varArray: EnvironmentVariableInfo[],
-		options: FlagsDef,
-	) {
-		const fields = ['id', 'name', 'value'];
-
-		if (options.all) {
-			// Replace undefined app names with 'N/A' or null
-			varArray = varArray.map((i: EnvironmentVariableInfo) => {
-				i.appName = i.appName || (options.json ? null : 'N/A');
-				return i;
-			});
-
-			fields.push(options.json ? 'appName' : 'appName => APPLICATION');
-			if (options.device) {
-				fields.push(options.json ? 'deviceUUID' : 'deviceUUID => DEVICE');
-			}
-			if (!options.config) {
-				fields.push(options.json ? 'serviceName' : 'serviceName => SERVICE');
-			}
-		}
-
-		if (options.json) {
-			this.log(
-				stringifyVarArray<SDK.EnvironmentVariableBase>(varArray, fields),
-			);
-		} else {
-			this.log(
-				getVisuals().table.horizontal(
-					_.sortBy(varArray, (v: SDK.EnvironmentVariableBase) => v.name),
-					fields,
-				),
-			);
-		}
-	}
-}
-
-async function validateServiceName(
-	sdk: SDK.BalenaSDK,
-	serviceName: string,
-	appName: string,
-) {
-	const services = await sdk.models.service.getAllByApplication(appName, {
-		$filter: { service_name: serviceName },
-	});
-	if (services.length === 0) {
-		throw new ExpectedError(
-			`Service "${serviceName}" not found for application "${appName}"`,
-		);
-	}
-}
-
-/**
- * Fetch application-wide config / env / service vars.
- * If options.application is undefined, an attempt is made to obtain the
- * application name from the device UUID (options.device). If this attempt
- * fails because the device does not belong to any application, an emtpy
- * array is returned.
- */
-async function getAppVars(
-	sdk: SDK.BalenaSDK,
-	appName: string | undefined,
-	options: FlagsDef,
-): Promise<EnvironmentVariableInfo[]> {
-	const appVars: EnvironmentVariableInfo[] = [];
-	if (!appName) {
-		return appVars;
-	}
-	if (options.config || options.all || !options.service) {
-		const vars = await sdk.models.application[
-			options.config ? 'configVar' : 'envVar'
-		].getAllByApplication(appName);
-		fillInInfoFields(vars, appName);
-		appVars.push(...vars);
-	}
-	if (!options.config && (options.service || options.all)) {
-		const pineOpts: SDK.PineOptions<SDK.ServiceEnvironmentVariable> = {
-			$expand: {
-				service: {},
-			},
-		};
-		if (options.service) {
-			pineOpts.$filter = {
-				service: {
-					service_name: options.service,
-				},
-			};
-		}
-		const serviceVars = await sdk.models.service.var.getAllByApplication(
-			appName,
-			pineOpts,
-		);
-		fillInInfoFields(serviceVars, appName);
-		appVars.push(...serviceVars);
-	}
-	return appVars;
-}
-
-/**
- * Fetch config / env / service vars when the '--device' option is provided.
- * Precondition: options.device must be defined.
- */
-async function getDeviceVars(
-	sdk: SDK.BalenaSDK,
-	fullUUID: string,
-	appName: 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, appName, printedUUID);
-		deviceVars.push(...deviceConfigVars);
-	} else {
-		if (options.service || options.all) {
-			const pineOpts: SDK.PineOptions<SDK.DeviceServiceEnvironmentVariable> = {
-				$expand: {
-					service_install: {
-						$expand: 'installs__service',
-					},
-				},
-			};
-			if (options.service) {
-				pineOpts.$filter = {
-					service_install: {
-						installs__service: { service_name: options.service },
-					},
-				};
-			}
-			const deviceServiceVars = await sdk.models.device.serviceVar.getAllByDevice(
-				fullUUID,
-				pineOpts,
-			);
-			fillInInfoFields(deviceServiceVars, appName, printedUUID);
-			deviceVars.push(...deviceServiceVars);
-		}
-		if (!options.service || options.all) {
-			const deviceEnvVars = await sdk.models.device.envVar.getAllByDevice(
-				fullUUID,
-			);
-			fillInInfoFields(deviceEnvVars, appName, printedUUID);
-			deviceVars.push(...deviceEnvVars);
-		}
-	}
-	return deviceVars;
-}
-
-/**
- * For each env var object in varArray, fill in its top-level serviceName
- * and deviceUUID fields. An asterisk is used to indicate that the variable
- * applies to "all services" or "all devices".
- */
-function fillInInfoFields(
-	varArray:
-		| EnvironmentVariableInfo[]
-		| DeviceServiceEnvironmentVariableInfo[]
-		| ServiceEnvironmentVariableInfo[],
-	appName?: string,
-	deviceUUID?: string,
-) {
-	for (const envVar of varArray) {
-		if ('service' in envVar) {
-			// envVar is of type ServiceEnvironmentVariableInfo
-			envVar.serviceName = (envVar.service as SDK.Service[])[0]?.service_name;
-		} else if ('service_install' in envVar) {
-			// envVar is of type DeviceServiceEnvironmentVariableInfo
-			envVar.serviceName = ((envVar.service_install as SDK.ServiceInstall[])[0]
-				?.installs__service as SDK.Service[])[0]?.service_name;
-		}
-		envVar.appName = appName;
-		envVar.serviceName = envVar.serviceName || '*';
-		envVar.deviceUUID = deviceUUID || '*';
-	}
-}
-
-/**
- * Transform each object (item) of varArray to preserve only the
- * fields (keys) listed in the fields argument.
- */
-function stringifyVarArray<T = Dictionary<any>>(
-	varArray: T[],
-	fields: string[],
-): string {
-	const transformed = varArray.map((o: Dictionary<any>) =>
-		_.transform(
-			o,
-			(result, value, key) => {
-				if (fields.includes(key)) {
-					result[key] = value;
-				}
-			},
-			{} as Dictionary<any>,
-		),
-	);
-	return JSON.stringify(transformed, null, 4);
-}

lib/actions-oclif/internal/scandevices.ts

@@ -1,46 +0,0 @@
-/**
- * @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 Command from '../../command';
-import { stripIndent } from '../../utils/lazy';
-
-// 'Internal' commands are called during the execution of other commands.
-// `scandevices` is called during by `join`,`leave'.
-// TODO: These should be refactored to modules/functions, and removed
-// 	See previous `internal sudo` refactor:
-//    - https://github.com/balena-io/balena-cli/pull/1455/files
-//    - https://github.com/balena-io/balena-cli/pull/1455#discussion_r334308357
-//    - https://github.com/balena-io/balena-cli/pull/1455#discussion_r334308526
-
-export default class ScandevicesCmd extends Command {
-	public static description = stripIndent`
-		Scan for local balena-enabled devices and show a picker to choose one.
-
-		Don't use this command directly!
-	`;
-
-	public static usage = 'internal scandevices';
-
-	public static root = true;
-	public static hidden = true;
-
-	public async run() {
-		const { forms } = await import('balena-sync');
-		const hostnameOrIp = await forms.selectLocalBalenaOsDevice();
-		return console.error(`==> Selected device: ${hostnameOrIp}`);
-	}
-}

lib/actions-oclif/os/download.ts

@@ -1,96 +0,0 @@
-/**
- * @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 { stripIndent } from '../../utils/lazy';
-
-interface FlagsDef {
-	output: string;
-	version?: string;
-	help: void;
-}
-
-interface ArgsDef {
-	type: string;
-}
-
-export default class OsDownloadCmd extends Command {
-	public static description = stripIndent`
-		Download an unconfigured OS image.
-
-		Download an unconfigured OS image for a certain device type.
-		Check available types with \`balena devices supported\`
-
-		Note: Currently this command only works with balenaCloud, not openBalena.
-		If using openBalena, please download the OS from: https://www.balena.io/os/
-
-		If version is not specified the newest stable (non-pre-release) version of OS
-		is downloaded (if available), otherwise the newest version (if all existing
-		versions for the given device type are pre-release).
-
-		You can pass \`--version menu\` to pick the OS version from the interactive menu
-		of all available versions.
-`;
-	public static examples = [
-		'$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img',
-		'$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version 1.24.1',
-		'$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version ^1.20.0',
-		'$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version latest',
-		'$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version default',
-		'$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version menu',
-	];
-
-	public static args = [
-		{
-			name: 'type',
-			description: 'the device type',
-			required: true,
-		},
-	];
-
-	public static usage = 'os download <type>';
-
-	public static flags: flags.Input<FlagsDef> = {
-		output: flags.string({
-			description: 'output path',
-			char: 'o',
-			required: true,
-		}),
-		version: flags.string({
-			description: stripIndent`
-				exact version number, or a valid semver range,
-				or 'latest' (includes pre-releases),
-				or 'default' (excludes pre-releases if at least one stable version is available),
-				or 'recommended' (excludes pre-releases, will fail if only pre-release versions are available),
-				or 'menu' (will show the interactive menu)
-				`,
-		}),
-		help: cf.help,
-	};
-
-	public async run() {
-		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
-			OsDownloadCmd,
-		);
-
-		const { downloadOSImage } = await import('../../utils/cloud');
-
-		await downloadOSImage(params.type, options.output, options.version);
-	}
-}

lib/actions-oclif/push.ts

@@ -1,415 +0,0 @@
-/**
- * @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 { getBalenaSdk, stripIndent } from '../utils/lazy';
-import { dockerignoreHelp, registrySecretsHelp } from '../utils/messages';
-import type { BalenaSDK, Application, Organization } from 'balena-sdk';
-import { ExpectedError, instanceOf } from '../errors';
-
-enum BuildTarget {
-	Cloud,
-	Device,
-}
-
-interface FlagsDef {
-	source?: string;
-	emulated: boolean;
-	dockerfile?: string; // DeviceDeployOptions.dockerfilePath (alternative Dockerfile)
-	nocache?: boolean;
-	'noparent-check'?: boolean;
-	'registry-secrets'?: string;
-	gitignore?: boolean;
-	nogitignore?: boolean;
-	nolive?: boolean;
-	detached?: boolean;
-	service?: string[];
-	system?: boolean;
-	env?: string[];
-	'convert-eol'?: boolean;
-	'noconvert-eol'?: boolean;
-	'multi-dockerignore'?: boolean;
-	help: void;
-}
-
-interface ArgsDef {
-	applicationOrDevice: string;
-}
-
-export default class PushCmd extends Command {
-	public static description = stripIndent`
-		Start a remote build on the balena cloud build servers or a local mode device.
-
-		start a build on the remote balena cloud builders,
-		or a local mode balena device.
-
-		When building on the balenaCloud servers, the given source directory will be
-		sent to the remote server. This can be used as a drop-in replacement for the
-		"git push" deployment method.
-
-		When building on a local mode device, the given source directory will be
-		built on the device, and the resulting containers will be run on the device.
-		Logs will be streamed back from the device as part of the same invocation.
-		The web dashboard can be used to switch a device to local mode:
-		https://www.balena.io/docs/learn/develop/local-mode/
-		Note that local mode requires a supervisor version of at least v7.21.0.
-		The logs from only a single service can be shown with the --service flag, and
-		showing only the system logs can be achieved with --system. Note that these
-		flags can be used together.
-
-		When pushing to a local device a live session will be started.
-		The project source folder is watched for filesystem events, and changes
-		to files and folders are automatically synchronized to the running
-		containers. The synchronization is only in one direction, from this machine to
-		the device, and changes made on the device itself may be overwritten.
-		This feature requires a device running supervisor version v9.7.0 or greater.
-
-		${registrySecretsHelp.split('\n').join('\n\t\t')}
-
-		${dockerignoreHelp.split('\n').join('\n\t\t')}
-
-		Note: --service and --env flags must come after the applicationOrDevice parameter,
-		as per examples.
-	`;
-
-	public static examples = [
-		'$ balena push myApp',
-		'$ balena push myApp --source <source directory>',
-		'$ balena push myApp -s <source directory>',
-		'',
-		'$ balena push 10.0.0.1',
-		'$ balena push 10.0.0.1 --source <source directory>',
-		'$ balena push 10.0.0.1 --service my-service',
-		'$ balena push 10.0.0.1 --env MY_ENV_VAR=value --env my-service:SERVICE_VAR=value',
-		'$ balena push 10.0.0.1 --nolive',
-		'',
-		'$ balena push 23c73a1.local --system',
-		'$ balena push 23c73a1.local --system --service my-service',
-	];
-
-	public static args = [
-		{
-			name: 'applicationOrDevice',
-			description: 'application name, or device address (for local pushes)',
-			required: true,
-		},
-	];
-
-	public static usage = 'push <applicationOrDevice>';
-
-	public static flags: flags.Input<FlagsDef> = {
-		source: flags.string({
-			description:
-				'Source directory to be sent to balenaCloud or balenaOS device (default: current working dir)',
-			char: 's',
-		}),
-		emulated: flags.boolean({
-			description: 'Force an emulated build to occur on the remote builder',
-			char: 'f',
-		}),
-		dockerfile: flags.string({
-			description:
-				'Alternative Dockerfile name/path, relative to the source folder',
-		}),
-		nocache: flags.boolean({
-			description: stripIndent`
-                Don't use cached layers of previously built images for this project. This ensures
-                that the latest base image and packages are pulled. Note that build logs may still
-                display the message _"Pulling previous images for caching purposes" (as the cloud
-                builder needs previous images to compute delta updates), but the logs will not
-                display the "Using cache" lines for each build step of a Dockerfile.`,
-
-			char: 'c',
-		}),
-		'noparent-check': flags.boolean({
-			description: `Disable project validation check of 'docker-compose.yml' file in parent folder`,
-		}),
-		'registry-secrets': flags.string({
-			description: stripIndent`
-				Path to a local YAML or JSON file containing Docker registry passwords used to pull base images.
-				Note that if registry-secrets are not provided on the command line, a secrets configuration
-				file from the balena directory will be used (usually $HOME/.balena/secrets.yml|.json)`,
-			char: 'R',
-		}),
-		nolive: flags.boolean({
-			description: stripIndent`
-				Don't run a live session on this push. The filesystem will not be monitored, and changes
-				will not be synchronized to any running containers. Note that both this flag and --detached
-				and required to cause the process to end once the initial build has completed.`,
-		}),
-		detached: flags.boolean({
-			description: stripIndent`
-				When pushing to the cloud, this option will cause the build to start, then return execution
-				back to the shell, with the status and release ID (if applicable).
-
-				When pushing to a local mode device, this option will cause the command to not tail application logs when the build
-				has completed.`,
-
-			char: 'd',
-		}),
-		service: flags.string({
-			description: stripIndent`
-				Reject logs not originating from this service.
-				This can be used in combination with --system and other --service flags.
-				Only valid when pushing to a local mode device.`,
-			multiple: true,
-		}),
-		system: flags.boolean({
-			description: stripIndent`
-				Only show system logs. This can be used in combination with --service.
-				Only valid when pushing to a local mode device.`,
-		}),
-		env: flags.string({
-			description: stripIndent`
-				When performing a push to device, run the built containers with environment
-				variables provided with this argument. Environment variables can be applied
-				to individual services by adding their service name before the argument,
-				separated by a colon, e.g:
-					--env main:MY_ENV=value
-				Note that if the service name cannot be found in the composition, the entire
-				left hand side of the = character will be treated as the variable name.
-			`,
-			multiple: true,
-		}),
-		'convert-eol': flags.boolean({
-			description: 'No-op and deprecated since balena CLI v12.0.0',
-			char: 'l',
-			hidden: true,
-		}),
-		'noconvert-eol': flags.boolean({
-			description: `Don't convert line endings from CRLF (Windows format) to LF (Unix format).`,
-		}),
-		'multi-dockerignore': flags.boolean({
-			description:
-				'Have each service use its own .dockerignore file. See "balena help push".',
-			char: 'm',
-			exclusive: ['gitignore'],
-		}),
-		nogitignore: flags.boolean({
-			description:
-				'No-op (default behavior) since balena CLI v12.0.0. See "balena help push".',
-			char: 'G',
-			hidden: true,
-		}),
-		gitignore: flags.boolean({
-			description: stripIndent`
-				Consider .gitignore files in addition to the .dockerignore file. This reverts
-				to the CLI v11 behavior/implementation (deprecated) if compatibility is required
-				until your project can be adapted.`,
-			char: 'g',
-			exclusive: ['multi-dockerignore'],
-		}),
-		help: cf.help,
-	};
-
-	public static primary = true;
-
-	public async run() {
-		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
-			PushCmd,
-		);
-
-		const sdk = getBalenaSdk();
-		const { validateProjectDirectory } = await import('../utils/compose_ts');
-
-		const source = options.source || '.';
-		if (process.env.DEBUG) {
-			console.error(`[debug] Using ${source} as build source`);
-		}
-
-		const { dockerfilePath, registrySecrets } = await validateProjectDirectory(
-			sdk,
-			{
-				dockerfilePath: options.dockerfile,
-				noParentCheck: options['noparent-check'] || false,
-				projectPath: source,
-				registrySecretsPath: options['registry-secrets'],
-			},
-		);
-
-		const nogitignore = !options.gitignore;
-		const convertEol = !options['noconvert-eol'];
-
-		const appOrDevice = params.applicationOrDevice;
-		const buildTarget = await this.getBuildTarget(appOrDevice);
-		switch (buildTarget) {
-			case BuildTarget.Cloud:
-				const remote = await import('../utils/remote-build');
-
-				// Check for invalid options
-				const localOnlyOptions = ['nolive', 'service', 'system', 'env'];
-
-				localOnlyOptions.forEach((opt) => {
-					// @ts-ignore : Not sure why typescript wont let me do this?
-					if (options[opt]) {
-						throw new ExpectedError(
-							`The --${opt} flag is only valid when pushing to a local mode device`,
-						);
-					}
-				});
-
-				const app = appOrDevice;
-				await Command.checkLoggedIn();
-				const [token, baseUrl, owner] = await Promise.all([
-					sdk.auth.getToken(),
-					sdk.settings.get('balenaUrl'),
-					this.getAppOwner(sdk, app),
-				]);
-
-				const opts = {
-					dockerfilePath,
-					emulated: options.emulated || false,
-					multiDockerignore: options['multi-dockerignore'] || false,
-					nocache: options.nocache || false,
-					registrySecrets,
-					headless: options.detached || false,
-					convertEol,
-				};
-				const args = {
-					app,
-					owner,
-					source,
-					auth: token,
-					baseUrl,
-					nogitignore,
-					sdk,
-					opts,
-				};
-				await remote.startRemoteBuild(args);
-				break;
-
-			case BuildTarget.Device:
-				const deviceDeploy = await import('../utils/device/deploy');
-				const device = appOrDevice;
-				const servicesToDisplay = options.service;
-
-				// TODO: Support passing a different port
-				try {
-					await deviceDeploy.deployToDevice({
-						source,
-						deviceHost: device,
-						dockerfilePath,
-						registrySecrets,
-						multiDockerignore: options['multi-dockerignore'] || false,
-						nocache: options.nocache || false,
-						nogitignore,
-						noParentCheck: options['noparent-check'] || false,
-						nolive: options.nolive || false,
-						detached: options.detached || false,
-						services: servicesToDisplay,
-						system: options.system || false,
-						env: options.env || [],
-						convertEol,
-					});
-				} catch (e) {
-					const { BuildError } = await import('../utils/device/errors');
-					if (instanceOf(e, BuildError)) {
-						throw new ExpectedError(e.toString());
-					} else {
-						throw e;
-					}
-				}
-				break;
-
-			default:
-				throw new ExpectedError(
-					stripIndent`
-					Build target not recognized. Please provide either an application name or device address.
-
-					The only supported device addresses currently are IP addresses.
-
-					If you believe your build target should have been detected, and this is an error, please
-					create an issue.`,
-				);
-		}
-	}
-
-	async getBuildTarget(appOrDevice: string): Promise<BuildTarget | null> {
-		const {
-			validateApplicationName,
-			validateDotLocalUrl,
-			validateIPAddress,
-		} = await import('../utils/validation');
-
-		// First try the application regex from the api
-		if (validateApplicationName(appOrDevice)) {
-			return BuildTarget.Cloud;
-		}
-
-		if (validateIPAddress(appOrDevice) || validateDotLocalUrl(appOrDevice)) {
-			return BuildTarget.Device;
-		}
-
-		return null;
-	}
-
-	async getAppOwner(sdk: BalenaSDK, appName: string) {
-		const _ = await import('lodash');
-
-		const applications = (await sdk.models.application.getAll({
-			$expand: {
-				organization: {
-					$select: ['handle'],
-				},
-			},
-			$filter: {
-				$eq: [{ $tolower: { $: 'app_name' } }, appName.toLowerCase()],
-			},
-			$select: ['id'],
-		})) as Array<
-			Application & {
-				organization: [Organization];
-			}
-		>;
-
-		if (applications == null || applications.length === 0) {
-			throw new ExpectedError(
-				stripIndent`
-			No applications found with name: ${appName}.
-
-			This could mean that the application does not exist, or you do
-			not have the permissions required to access it.`,
-			);
-		}
-
-		if (applications.length === 1) {
-			return applications[0].organization[0].handle;
-		}
-
-		// If we got more than one application with the same name it means that the
-		// user has access to a collab app with the same name as a personal app. We
-		// present a list to the user which shows the fully qualified application
-		// name (user/appname) and allows them to select
-		const entries = _.map(applications, (app) => {
-			const username = app.organization[0].handle;
-			return {
-				name: `${username}/${appName}`,
-				extra: username,
-			};
-		});
-
-		const { selectFromList } = await import('../utils/patterns');
-		const selected = await selectFromList(
-			`${entries.length} applications found with that name, please select the application you would like to push to`,
-			entries,
-		);
-
-		return selected.extra;
-	}
-}

lib/actions-oclif/ssh.ts

@@ -1,393 +0,0 @@
-/**
- * @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 { getBalenaSdk, stripIndent } from '../utils/lazy';
-import {
-	parseAsInteger,
-	validateDotLocalUrl,
-	validateIPAddress,
-} from '../utils/validation';
-import * as BalenaSdk from 'balena-sdk';
-
-interface FlagsDef {
-	port?: number;
-	tty: boolean;
-	verbose: boolean;
-	noproxy: boolean;
-	help: void;
-}
-
-interface ArgsDef {
-	applicationOrDevice: string;
-	serviceName?: string;
-}
-
-export default class NoteCmd extends Command {
-	public static description = stripIndent`
-		SSH into the host or application container of a device.
-
-		Start a shell on a local or remote device. If a service name is not provided,
-		a shell will be opened on the host OS.
-
-		If an application name is provided, an interactive menu will be presented
-		for the selection of an online device. A shell will then be opened for the
-		host OS or service container of the chosen device.
-
-		For local devices, the IP address and .local domain name are supported.
-		If the device is referenced by IP or \`.local\` address, the connection
-		is initiated directly to balenaOS on port \`22222\` via an
-		openssh-compatible client. Otherwise, any connection initiated remotely
-		traverses the balenaCloud VPN.
-
-		Commands may be piped to the standard input for remote execution (see examples).
-		Note however that remote command execution on service containers (as opposed to
-		the host OS) is not currently possible when a device UUID is used (instead of
-		an IP address) because of a balenaCloud backend limitation.
-
-		Note: \`balena ssh\` requires an openssh-compatible client to be correctly
-		installed in your shell environment. For more information (including Windows
-		support) please check:
-			https://github.com/balena-io/balena-cli/blob/master/INSTALL.md#additional-dependencies,
-	`;
-
-	public static examples = [
-		'$ balena ssh MyApp',
-		'$ balena ssh f49cefd',
-		'$ balena ssh f49cefd my-service',
-		'$ balena ssh f49cefd --port <port>',
-		'$ balena ssh 192.168.0.1 --verbose',
-		'$ balena ssh f49cefd.local my-service',
-		'$ echo "uptime; exit;" | balena ssh f49cefd',
-		'$ echo "uptime; exit;" | balena ssh 192.168.0.1 myService',
-	];
-
-	public static args = [
-		{
-			name: 'applicationOrDevice',
-			description: 'application name, device uuid, or address of local device',
-			required: true,
-		},
-		{
-			name: 'serviceName',
-			description: 'service name, if connecting to a container',
-			required: false,
-		},
-	];
-
-	public static usage = 'ssh <applicationOrDevice> [serviceName]';
-
-	public static flags: flags.Input<FlagsDef> = {
-		port: flags.integer({
-			description: stripIndent`
-				SSH server port number (default 22222) if the target is an IP address or .local
-				hostname. Otherwise, port number for the balenaCloud gateway (default 22).`,
-			char: 'p',
-			parse: (p) => parseAsInteger(p, 'port'),
-		}),
-		tty: flags.boolean({
-			description:
-				'Force pseudo-terminal allocation (bypass TTY autodetection for stdin)',
-			char: 't',
-		}),
-		verbose: flags.boolean({
-			description: 'Increase verbosity',
-			char: 'v',
-		}),
-		noproxy: flags.boolean({
-			description: 'Bypass global proxy configuration for the ssh connection',
-		}),
-		help: cf.help,
-	};
-
-	public static primary = true;
-
-	public async run() {
-		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
-			NoteCmd,
-		);
-
-		// if we're doing a direct SSH connection locally...
-		if (
-			validateDotLocalUrl(params.applicationOrDevice) ||
-			validateIPAddress(params.applicationOrDevice)
-		) {
-			const { performLocalDeviceSSH } = await import('../utils/device/ssh');
-			return await performLocalDeviceSSH({
-				address: params.applicationOrDevice,
-				port: options.port,
-				forceTTY: options.tty,
-				verbose: options.verbose,
-				service: params.serviceName,
-			});
-		}
-
-		const { getProxyConfig, which } = await import('../utils/helpers');
-		const { checkLoggedIn, getOnlineTargetUuid } = await import(
-			'../utils/patterns'
-		);
-		const sdk = getBalenaSdk();
-
-		const proxyConfig = getProxyConfig();
-		const useProxy = !!proxyConfig && !options.noproxy;
-
-		// this will be a tunnelled SSH connection...
-		await checkLoggedIn();
-		const uuid = await getOnlineTargetUuid(sdk, params.applicationOrDevice);
-		let version: string | undefined;
-		let id: number | undefined;
-
-		const device = await sdk.models.device.get(uuid, {
-			$select: ['id', 'supervisor_version', 'is_online'],
-		});
-		id = device.id;
-		version = device.supervisor_version;
-
-		const [whichProxytunnel, username, proxyUrl] = await Promise.all([
-			useProxy ? which('proxytunnel', false) : undefined,
-			sdk.auth.whoami(),
-			// note that `proxyUrl` refers to the balenaCloud "resin-proxy"
-			// service, currently "balena-devices.com", rather than some
-			// local proxy server URL
-			sdk.settings.get('proxyUrl'),
-		]);
-
-		const getSshProxyCommand = () => {
-			if (!proxyConfig) {
-				return;
-			}
-			if (!whichProxytunnel) {
-				console.warn(stripIndent`
-					Proxy is enabled but the \`proxytunnel\` binary cannot be found.
-					Please install it if you want to route the \`balena ssh\` requests through the proxy.
-					Alternatively you can pass \`--noproxy\` param to the \`balena ssh\` command to ignore the proxy config
-					for the \`ssh\` requests.
-
-					Attempting the unproxied request for now.`);
-				return;
-			}
-
-			const p = proxyConfig;
-			if (p.username && p.password) {
-				// proxytunnel understands these variables for proxy authentication.
-				// Setting the variables instead of command-line options avoids the
-				// need for shell-specific escaping of special characters like '$'.
-				process.env.PROXYUSER = p.username;
-				process.env.PROXYPASS = p.password;
-			}
-
-			return [
-				'proxytunnel',
-				`--proxy=${p.host}:${p.port}`,
-				// ssh replaces these %h:%p variables in the ProxyCommand option
-				// https://linux.die.net/man/5/ssh_config
-				'--dest=%h:%p',
-				...(options.verbose ? ['--verbose'] : []),
-			];
-		};
-
-		const proxyCommand = useProxy ? getSshProxyCommand() : undefined;
-
-		if (username == null) {
-			const { ExpectedError } = await import('../errors');
-			throw new ExpectedError(
-				`Opening an SSH connection to a remote device requires you to be logged in.`,
-			);
-		}
-
-		// At this point, we have a long uuid with a device
-		// that we know exists and is accessible
-		let containerId: string | undefined;
-		if (params.serviceName != null) {
-			containerId = await this.getContainerId(
-				sdk,
-				uuid,
-				params.serviceName,
-				{
-					port: options.port,
-					proxyCommand,
-					proxyUrl: proxyUrl || '',
-					username: username!,
-				},
-				version,
-				id,
-			);
-		}
-
-		let accessCommand: string;
-		if (containerId != null) {
-			accessCommand = `enter ${uuid} ${containerId}`;
-		} else {
-			accessCommand = `host ${uuid}`;
-		}
-
-		const command = this.generateVpnSshCommand({
-			uuid,
-			command: accessCommand,
-			verbose: options.verbose,
-			port: options.port,
-			proxyCommand,
-			proxyUrl: proxyUrl || '',
-			username: username!,
-		});
-
-		const { spawnSshAndThrowOnError } = await import('../utils/ssh');
-		return spawnSshAndThrowOnError(command);
-	}
-
-	async getContainerId(
-		sdk: BalenaSdk.BalenaSDK,
-		uuid: string,
-		serviceName: string,
-		sshOpts: {
-			port?: number;
-			proxyCommand?: string[];
-			proxyUrl: string;
-			username: string;
-		},
-		version?: string,
-		id?: number,
-	): Promise<string> {
-		const semver = await import('balena-semver');
-
-		if (version == null || id == null) {
-			const device = await sdk.models.device.get(uuid, {
-				$select: ['id', 'supervisor_version'],
-			});
-			version = device.supervisor_version;
-			id = device.id;
-		}
-
-		let containerId: string | undefined;
-		if (semver.gte(version, '8.6.0')) {
-			const apiUrl = await sdk.settings.get('apiUrl');
-			// TODO: Move this into the SDKs device model
-			const request = await sdk.request.send({
-				method: 'POST',
-				url: '/supervisor/v2/containerId',
-				baseUrl: apiUrl,
-				body: {
-					method: 'GET',
-					deviceId: id,
-				},
-			});
-			if (request.status !== 200) {
-				throw new Error(
-					`There was an error connecting to device ${uuid}, HTTP response code: ${request.status}.`,
-				);
-			}
-			const body = request.body;
-			if (body.status !== 'success') {
-				throw new Error(
-					`There was an error communicating with device ${uuid}.\n\tError: ${body.message}`,
-				);
-			}
-			containerId = body.services[serviceName];
-		} else {
-			console.error(stripIndent`
-			Using legacy method to detect container ID. This will be slow.
-			To speed up this process, please update your device to an OS
-			which has a supervisor version of at least v8.6.0.
-		`);
-			// We need to execute a balena ps command on the device,
-			// and parse the output, looking for a specific
-			// container
-			const childProcess = await import('child_process');
-			const { escapeRegExp } = await import('lodash');
-			const { which } = await import('../utils/helpers');
-			const { deviceContainerEngineBinary } = await import(
-				'../utils/device/ssh'
-			);
-
-			const sshBinary = await which('ssh');
-			const sshArgs = this.generateVpnSshCommand({
-				uuid,
-				verbose: false,
-				port: sshOpts.port,
-				command: `host ${uuid} "${deviceContainerEngineBinary}" ps --format "{{.ID}} {{.Names}}"`,
-				proxyCommand: sshOpts.proxyCommand,
-				proxyUrl: sshOpts.proxyUrl,
-				username: sshOpts.username,
-			});
-
-			if (process.env.DEBUG) {
-				console.error(`[debug] [${sshBinary}, ${sshArgs.join(', ')}]`);
-			}
-			const subProcess = childProcess.spawn(sshBinary, sshArgs, {
-				stdio: [null, 'pipe', null],
-			});
-			const containers = await new Promise<string>((resolve, reject) => {
-				const output: string[] = [];
-				subProcess.stdout.on('data', (chunk) => output.push(chunk.toString()));
-				subProcess.on('close', (code: number) => {
-					if (code !== 0) {
-						reject(
-							new Error(
-								`Non-zero error code when looking for service container: ${code}`,
-							),
-						);
-					} else {
-						resolve(output.join(''));
-					}
-				});
-			});
-
-			const lines = containers.split('\n');
-			const regex = new RegExp(`\\/?${escapeRegExp(serviceName)}_\\d+_\\d+`);
-			for (const container of lines) {
-				const [cId, name] = container.split(' ');
-				if (regex.test(name)) {
-					containerId = cId;
-					break;
-				}
-			}
-		}
-
-		if (containerId == null) {
-			throw new Error(
-				`Could not find a service ${serviceName} on device ${uuid}.`,
-			);
-		}
-		return containerId;
-	}
-
-	generateVpnSshCommand(opts: {
-		uuid: string;
-		command: string;
-		verbose: boolean;
-		port?: number;
-		username: string;
-		proxyUrl: string;
-		proxyCommand?: string[];
-	}) {
-		return [
-			...(opts.verbose ? ['-vvv'] : []),
-			'-t',
-			...['-o', 'LogLevel=ERROR'],
-			...['-o', 'StrictHostKeyChecking=no'],
-			...['-o', 'UserKnownHostsFile=/dev/null'],
-			...(opts.proxyCommand && opts.proxyCommand.length
-				? ['-o', `ProxyCommand=${opts.proxyCommand.join(' ')}`]
-				: []),
-			...(opts.port ? ['-p', opts.port.toString()] : []),
-			`${opts.username}@ssh.${opts.proxyUrl}`,
-			opts.command,
-		];
-	}
-}

lib/actions/help.js

@@ -1,190 +0,0 @@
-/*
-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 * as _ from 'lodash';
-
-import * as capitano from 'capitano';
-import * as columnify from 'columnify';
-import * as messages from '../utils/messages';
-import { getManualSortCompareFunction } from '../utils/helpers';
-import { exitWithExpectedError } from '../errors';
-import { getOclifHelpLinePairs } from './help_ts';
-
-const parse = (object) =>
-	_.map(object, function (item) {
-		// Hacky way to determine if an object is
-		// a function or a command
-		let signature;
-		if (item.alias != null) {
-			signature = item.toString();
-		} else {
-			signature = item.signature.toString();
-		}
-
-		return [signature, item.description];
-	});
-
-const indent = function (text) {
-	text = _.map(text.split('\n'), (line) => '    ' + line);
-	return text.join('\n');
-};
-
-const print = (usageDescriptionPairs) =>
-	console.log(
-		indent(
-			columnify(_.fromPairs(usageDescriptionPairs), {
-				showHeaders: false,
-				minWidth: 35,
-			}),
-		),
-	);
-
-const manuallySortedPrimaryCommands = [
-	'help',
-	'login',
-	'push',
-	'logs',
-	'ssh',
-	'apps',
-	'app',
-	'devices',
-	'device',
-	'tunnel',
-	'preload',
-	'build',
-	'deploy',
-	'join',
-	'leave',
-	'local scan',
-];
-
-const general = function (_params, options, done) {
-	console.log('Usage: balena [COMMAND] [OPTIONS]\n');
-
-	console.log('Primary commands:\n');
-
-	// We do not want the wildcard command
-	// to be printed in the help screen.
-	const commands = capitano.state.commands.filter(
-		(command) => !command.hidden && !command.isWildcard(),
-	);
-
-	const capitanoCommands = _.groupBy(commands, function (command) {
-		if (command.primary) {
-			return 'primary';
-		}
-		return 'secondary';
-	});
-
-	return getOclifHelpLinePairs()
-		.then(function (oclifHelpLinePairs) {
-			const primaryHelpLinePairs = parse(capitanoCommands.primary)
-				.concat(oclifHelpLinePairs.primary)
-				.sort(
-					getManualSortCompareFunction(manuallySortedPrimaryCommands, function (
-						[signature],
-						manualItem,
-					) {
-						return (
-							signature === manualItem || signature.startsWith(`${manualItem} `)
-						);
-					}),
-				);
-
-			const secondaryHelpLinePairs = parse(capitanoCommands.secondary)
-				.concat(oclifHelpLinePairs.secondary)
-				.sort();
-
-			print(primaryHelpLinePairs);
-
-			if (options.verbose) {
-				console.log('\nAdditional commands:\n');
-				print(secondaryHelpLinePairs);
-			} else {
-				console.log(
-					'\nRun `balena help --verbose` to list additional commands',
-				);
-			}
-
-			if (!_.isEmpty(capitano.state.globalOptions)) {
-				console.log('\nGlobal Options:\n');
-				print(parse(capitano.state.globalOptions).sort());
-			}
-			console.log(indent('--debug\n'));
-
-			console.log(messages.help);
-
-			return done();
-		})
-		.catch(done);
-};
-
-const commandHelp = (params, _options, done) =>
-	capitano.state.getMatchCommand(params.command, function (error, command) {
-		if (error != null) {
-			return done(error);
-		}
-
-		if (command == null || command.isWildcard()) {
-			exitWithExpectedError(`Command not found: ${params.command}`);
-		}
-
-		console.log(`Usage: ${command.signature}`);
-
-		if (command.help != null) {
-			console.log(`\n${command.help}`);
-		} else if (command.description != null) {
-			console.log(`\n${_.capitalize(command.description)}`);
-		}
-
-		if (!_.isEmpty(command.options)) {
-			console.log('\nOptions:\n');
-			print(parse(command.options).sort());
-		}
-
-		console.log();
-
-		return done();
-	});
-
-export const help = {
-	signature: 'help [command...]',
-	description: 'show help',
-	help: `\
-Get detailed help for an specific command.
-
-Examples:
-
-	$ balena help apps
-	$ balena help os download\
-`,
-	primary: true,
-	options: [
-		{
-			signature: 'verbose',
-			description: 'show additional commands',
-			boolean: true,
-			alias: 'v',
-		},
-	],
-	action(params, options, done) {
-		if (params.command != null) {
-			return commandHelp(params, options, done);
-		} else {
-			return general(params, options, done);
-		}
-	},
-};

lib/actions/help_ts.ts

@@ -1,65 +0,0 @@
-/**
- * @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 _ from 'lodash';
-import * as path from 'path';
-import Command from '../command';
-
-import { capitanoizeOclifUsage } from '../utils/oclif-utils';
-
-export async function getOclifHelpLinePairs() {
-	const { convertedCommands } = await import('../preparser');
-	const primary: Array<[string, string]> = [];
-	const secondary: Array<[string, string]> = [];
-
-	for (const convertedCmd of convertedCommands) {
-		const [topic, cmd] = convertedCmd.split(':');
-		const pathComponents = ['..', 'actions-oclif', topic];
-		if (cmd) {
-			pathComponents.push(cmd);
-		}
-
-		const cmdModule = await import(path.join(...pathComponents));
-		const command: typeof Command = cmdModule.default;
-
-		if (!command.hidden) {
-			if (command.primary) {
-				primary.push(getCmdUsageDescriptionLinePair(command));
-			} else {
-				secondary.push(getCmdUsageDescriptionLinePair(command));
-			}
-		}
-	}
-
-	return { primary, secondary };
-}
-
-function getCmdUsageDescriptionLinePair(cmd: typeof Command): [string, string] {
-	const usage = capitanoizeOclifUsage(cmd.usage);
-	let description = '';
-	// note: [^] matches any characters (including line breaks), achieving the
-	// same effect as the 's' regex flag which is only supported by Node 9+
-	const matches = /\s*([^]+?)\n[^]*/.exec(cmd.description || '');
-	if (matches && matches.length > 1) {
-		description = _.trimEnd(matches[1], '.');
-		// Only do .lowerFirst() if the second char is not uppercase (e.g. for 'SSH');
-		if (description[1] !== description[1]?.toUpperCase()) {
-			description = _.lowerFirst(description);
-		}
-	}
-	return [usage, description];
-}

lib/app-capitano.ts

@@ -1,78 +0,0 @@
-/*
-Copyright 2016-2020 Balena
-
-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 capitano from 'capitano';
-import * as actions from './actions';
-import * as events from './events';
-import { promisify } from 'util';
-
-capitano.permission('user', (done) =>
-	require('./utils/patterns').checkLoggedIn().then(done, done),
-);
-
-capitano.command({
-	signature: '*',
-	action(_params, _options, done) {
-		capitano.execute({ command: 'help' }, done);
-		process.exitCode = process.exitCode || 1;
-	},
-});
-
-capitano.globalOption({
-	signature: 'help',
-	boolean: true,
-	alias: 'h',
-});
-
-capitano.globalOption({
-	signature: 'version',
-	boolean: true,
-	alias: 'v',
-});
-
-// ---------- Help Module ----------
-capitano.command(actions.help.help);
-
-export function run(argv: string[]) {
-	const cli = capitano.parse(argv.slice(2));
-	const runCommand = function () {
-		const capitanoExecuteAsync = promisify(capitano.execute);
-		if (cli.global?.help) {
-			return capitanoExecuteAsync({
-				command: `help ${cli.command ?? ''}`,
-			});
-		} else {
-			return capitanoExecuteAsync(cli);
-		}
-	};
-
-	const trackCommand = function () {
-		const getMatchCommandAsync = promisify(capitano.state.getMatchCommand);
-		return getMatchCommandAsync(cli.command).then(function (command) {
-			// cmdSignature is literally a string like, for example:
-			//     "push <applicationOrDevice>"
-			// ("applicationOrDevice" is NOT replaced with its actual value)
-			// In case of failures like an nonexistent or invalid command,
-			// command.signature.toString() returns '*'
-			const cmdSignature = command.signature.toString();
-			return events.trackCommand(cmdSignature);
-		});
-	};
-
-	return Promise.all([trackCommand(), runCommand()]).catch(
-		require('./errors').handleError,
-	);
-}

lib/app-oclif.ts

@@ -1,61 +0,0 @@
-/**
- * @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 { Main } from '@oclif/command';
-
-import { trackPromise } from './hooks/prerun/track';
-
-class CustomMain extends Main {
-	protected _helpOverride(): boolean {
-		// Disable oclif's default handler for the 'version' command
-		if (['-v', '--version', 'version'].includes(this.argv[0])) {
-			return false;
-		} else {
-			return super._helpOverride();
-		}
-	}
-}
-
-import type { AppOptions } from './preparser';
-
-/**
- * oclif CLI entrypoint
- */
-export async function run(command: string[], options: AppOptions) {
-	const runPromise = CustomMain.run(command).then(
-		() => {
-			if (!options.noFlush) {
-				return require('@oclif/command/flush');
-			}
-		},
-		(error) => {
-			// oclif sometimes exits with ExitError code 0 (not an error)
-			// (Avoid `error instanceof ExitError` here for the reasons explained
-			// in the CONTRIBUTING.md file regarding the `instanceof` operator.)
-			if (error.oclif?.exit === 0) {
-				return;
-			} else {
-				throw error;
-			}
-		},
-	);
-	try {
-		await Promise.all([trackPromise, runPromise]);
-	} catch (err) {
-		await (await import('./errors')).handleError(err);
-	}
-}

lib/app.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2019 Balena Ltd.
+ * Copyright 2019-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.
@@ -15,73 +15,174 @@
  * limitations under the License.
  */
 
+import * as packageJSON from '../package.json';
+import {
+	AppOptions,
+	checkDeletedCommand,
+	preparseArgs,
+	unsupportedFlag,
+} from './preparser';
+import { CliSettings } from './utils/bootstrap';
+import { onceAsync } from './utils/lazy';
+
 /**
- * CLI entrypoint, but see also `bin/balena` and `bin/balena-dev` which
- * call this function.
+ * Sentry.io setup
+ * @see https://docs.sentry.io/error-reporting/quickstart/?platform=node
  */
-export async function run(
-	cliArgs = process.argv,
-	options: import('./preparser').AppOptions = {},
-) {
-	// DEBUG set to falsy for negative values else is truthy
-	process.env.DEBUG = ['0', 'no', 'false', '', undefined].includes(
-		process.env.DEBUG?.toLowerCase(),
-	)
-		? ''
-		: '1';
+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.configureScope((scope) => {
+		scope.setExtras({
+			is_pkg: !!(process as any).pkg,
+			node_version: process.version,
+			platform: process.platform,
+		});
+	});
+	return Sentry.getCurrentHub();
+});
 
-	// 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));
+async function checkNodeVersion() {
+	const validNodeVersions = packageJSON.engines.node;
+	if (!(await import('semver')).satisfies(process.version, validNodeVersions)) {
+		const { getNodeEngineVersionWarn } = await import('./utils/messages');
+		console.warn(getNodeEngineVersionWarn(process.version, validNodeVersions));
 	}
+}
 
-	const { globalInit } = await import('./app-common');
-	const { routeCliFramework } = await import('./preparser');
-
-	// globalInit() must be called very early on (before other imports) because
-	// it sets up Sentry error reporting, global HTTP proxy settings, balena-sdk
-	// shared options, and performs node version requirement checks.
-	await globalInit();
-	await routeCliFramework(cliArgs, options);
-
-	// Windows fix: reading from stdin prevents the process from exiting
-	process.stdin.pause();
+/** Setup balena-sdk options that are shared with imported packages */
+function setupBalenaSdkSharedOptions(settings: CliSettings) {
+	const BalenaSdk = require('balena-sdk') as typeof import('balena-sdk');
+	BalenaSdk.setSharedOptions({
+		apiUrl: settings.get<string>('apiUrl'),
+		dataDirectory: settings.get<string>('dataDirectory'),
+	});
 }
 
 /**
- * Implements the 'pkgExec' command, used as a way to provide a Node.js
- * interpreter for child_process.spawn()-like operations when the CLI is
- * executing as a standalone zip package (built-in Node interpreter) and
- * the system may not have a separate Node.js installation. A present use
- * case is a patched version of the 'windosu' package that requires a
- * Node.js interpreter to spawn a privileged child process.
- *
- * @param modFunc Path to a JS module that will be executed via require().
- * The modFunc argument may optionally contain a function name separated
- * by '::', for example '::main' in:
- * 'C:\\snapshot\\balena-cli\\node_modules\\windosu\\lib\\pipe.js::main'
- * in which case that function is executed in the require'd module.
- * @param args Optional arguments to passed through process.argv and as
- * arguments to the function specified via modFunc.
+ * Addresses the console warning:
+ * (node:49500) MaxListenersExceededWarning: Possible EventEmitter memory
+ * leak detected. 11 error listeners added. Use emitter.setMaxListeners() to
+ * increase limit
  */
-async function pkgExec(modFunc: string, args: string[]) {
-	const [modPath, funcName] = modFunc.split('::');
-	let replacedModPath = modPath;
-	const match = modPath
-		.replace(/\\/g, '/')
-		.match(/\/snapshot\/balena-cli\/(.+)/);
-	if (match) {
-		replacedModPath = `../${match[1]}`;
-	}
-	process.argv = [process.argv[0], process.argv[1], ...args];
-	try {
-		const mod: any = await import(replacedModPath);
-		if (funcName) {
-			await mod[funcName](...args);
+export function setMaxListeners(maxListeners: number) {
+	require('events').EventEmitter.defaultMaxListeners = maxListeners;
+}
+
+/** 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`);
 		}
-	} catch (err) {
-		console.error(`Error executing pkgExec "${modFunc}" [${args.join()}]`);
-		console.error(err);
+	} else {
+		await setupSentry();
+	}
+	await checkNodeVersion();
+
+	const settings = new CliSettings();
+
+	// Proxy setup should be done early on, before loading balena-sdk
+	await (await import('./utils/proxy')).setupGlobalHttpProxy(settings);
+
+	setupBalenaSdkSharedOptions(settings);
+
+	// check for CLI updates once a day
+	if (!process.env.BALENARC_OFFLINE_MODE) {
+		(await import('./utils/update')).notify();
+	}
+}
+
+/** Execute the oclif parser and the CLI command. */
+async function oclifRun(command: string[], options: AppOptions) {
+	let deprecationPromise: Promise<void>;
+	// check and enforce the CLI's deprecation policy
+	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
+		await deprecationChecker.warnAndAbortIfDeprecated();
+		// checkForNewReleasesIfNeeded may query the npm registry
+		deprecationPromise = deprecationChecker.checkForNewReleasesIfNeeded();
+	}
+
+	const runPromise = (async function (shouldFlush: boolean) {
+		const { CustomMain } = await import('./utils/oclif-utils');
+		let isEEXIT = false;
+		try {
+			await CustomMain.run(command);
+		} catch (error) {
+			// oclif sometimes exits with ExitError code EEXIT 0 (not an error),
+			// for example the `balena help` command.
+			// (Avoid `error instanceof ExitError` here for the reasons explained
+			// in the CONTRIBUTING.md file regarding the `instanceof` operator.)
+			if (error.oclif?.exit === 0) {
+				isEEXIT = true;
+			} else {
+				throw error;
+			}
+		}
+		if (shouldFlush) {
+			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.
+		// If it is not called here as well, there is a process exit delay of
+		// 1 second when the fast-boot2 cache is modified (1 second is the
+		// default cache saving timeout). Try for example `balena help`.
+		// I have found that, when oclif's `Error: EEXIT: 0` is caught in
+		// the try/catch block above, execution does not get past the
+		// Promise.all() call below, but I don't understand why.
+		if (isEEXIT) {
+			(await import('./fast-boot')).stop();
+		}
+	})(!options.noFlush);
+
+	const { trackPromise } = await import('./hooks/prerun/track');
+
+	await Promise.all([trackPromise, deprecationPromise, runPromise]);
+}
+
+/** CLI entrypoint. Called by the `bin/balena` and `bin/balena-dev` scripts. */
+export async function run(cliArgs = process.argv, options: AppOptions = {}) {
+	try {
+		const { setOfflineModeEnvVars, normalizeEnvVars, pkgExec } = await import(
+			'./utils/bootstrap'
+		);
+		setOfflineModeEnvVars();
+		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
+		checkDeletedCommand(cliArgs.slice(2));
+
+		const args = await preparseArgs(cliArgs);
+		await oclifRun(args, options);
+	} catch (err) {
+		await (await import('./errors')).handleError(err);
+	} finally {
+		try {
+			(await import('./fast-boot')).stop();
+		} catch (e) {
+			if (process.env.DEBUG) {
+				console.error(`[debug] Stopping fast-boot: ${e}`);
+			}
+		}
+		// Windows fix: reading from stdin prevents the process from exiting
+		process.stdin.pause();
 	}
 }

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');
-	open(loginUrl, { wait: false });
+	await open(loginUrl, { wait: false });
 
 	const balena = getBalenaSdk();
 	const token = await loginServer.awaitForToken();

lib/auth/pages/error.ejs

@@ -3,7 +3,7 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="x-ua-compatible" content="ie=edge">
-	<title>Balena CLI - Error</title>
+	<title>balena CLI - Error</title>
 	<meta name="description" content="">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" type="text/css" href="./static/style.css" inline>

lib/auth/pages/success.ejs

@@ -3,7 +3,7 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="x-ua-compatible" content="ie=edge">
-	<title>Balena CLI - Success</title>
+	<title>balena CLI - Success</title>
 	<meta name="description" content="">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" type="text/css" href="./static/style.css" inline>

lib/auth/server.ts

@@ -59,14 +59,15 @@ export class LoginServer extends EventEmitter {
 		app.set('views', path.join(__dirname, 'pages'));
 
 		this.server = await new Promise<import('net').Server>((resolve, reject) => {
-			const server = app.listen(port, host, (err: Error) => {
+			const callback = (err: Error) => {
 				if (err) {
 					this.emit('error', err);
 					reject(err);
 				} else {
 					resolve(server);
 				}
-			});
+			};
+			const server = app.listen(port, host, callback as any);
 			server.on('connection', (socket) => this.serverSockets.push(socket));
 		});
 

lib/auth/utils.ts

@@ -14,57 +14,44 @@ 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';
 
 /**
- * @summary Get dashboard CLI login URL
- * @function
- * @protected
+ * Get dashboard CLI login URL
  *
- * @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)
+ * @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'
  */
-export const getDashboardLoginURL = (callbackUrl: string) => {
+export async function getDashboardLoginURL(
+	callbackUrl: string,
+): Promise<string> {
 	// Encode percentages signs from the escaped url
 	// characters to avoid angular getting confused.
 	callbackUrl = encodeURIComponent(callbackUrl).replace(/%/g, '%25');
 
-	return getBalenaSdk()
-		.settings.get('dashboardUrl')
-		.then((dashboardUrl) =>
-			url.resolve(dashboardUrl, `/login/cli/${callbackUrl}`),
-		);
-};
+	const [{ URL }, dashboardUrl] = await Promise.all([
+		import('url'),
+		getBalenaSdk().settings.get('dashboardUrl'),
+	]);
+	return new URL(`/login/cli/${callbackUrl}`, dashboardUrl).href;
+}
 
 /**
- * @summary Log in using a token, but only if the token is valid
- * @function
- * @protected
+ * Log in using a token, but only if the token is valid.
  *
- * @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 {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!')
+ * @param token - session token or api key
+ * @returns whether the login was successful or not
  */
-export const loginIfTokenValid = async (token: string): Promise<boolean> => {
-	if (_.isEmpty(token?.trim())) {
+export async function loginIfTokenValid(token?: string): Promise<boolean> {
+	token = (token || '').trim();
+	if (!token) {
 		return false;
 	}
 	const balena = getBalenaSdk();
@@ -86,4 +73,4 @@ export const loginIfTokenValid = async (token: string): Promise<boolean> => {
 		}
 	}
 	return isLoggedIn;
-};
+}

lib/command.ts

@@ -16,7 +16,12 @@
  */
 
 import Command from '@oclif/command';
-import { InsufficientPrivilegesError } from './errors';
+import {
+	InsufficientPrivilegesError,
+	NotAvailableInOfflineModeError,
+} from './errors';
+import { stripIndent } from './utils/lazy';
+import * as output from './framework/output';
 
 export default abstract class BalenaCommand extends Command {
 	/**
@@ -40,6 +45,13 @@ export default abstract class BalenaCommand extends Command {
 	 */
 	public static authenticated = false;
 
+	/**
+	 * Require an internet connection to run.
+	 * When set to true, command will exit with an error
+	 * if user is running in offline mode (BALENARC_OFFLINE_MODE).
+	 */
+	public static offlineCompatible = false;
+
 	/**
 	 * Accept piped input.
 	 * When set to true, command will read from stdin during init
@@ -97,6 +109,29 @@ export default abstract class BalenaCommand extends Command {
 		}
 	}
 
+	/**
+	 * Throw NotAvailableInOfflineModeError if in offline mode.
+	 *
+	 * Called automatically if `onlineOnly=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 {NotAvailableInOfflineModeError}
+	 */
+	public static checkNotUsingOfflineMode() {
+		if (process.env.BALENARC_OFFLINE_MODE) {
+			throw new NotAvailableInOfflineModeError(stripIndent`
+		This command requires an internet connection, and cannot be used in offline mode.
+		To leave offline mode, unset the BALENARC_OFFLINE_MODE environment variable.
+		`);
+		}
+	}
+
 	/**
 	 * Read stdin contents and make available to command.
 	 *
@@ -125,8 +160,15 @@ export default abstract class BalenaCommand extends Command {
 			await BalenaCommand.checkLoggedIn();
 		}
 
+		if (!ctr.offlineCompatible) {
+			BalenaCommand.checkNotUsingOfflineMode();
+		}
+
 		if (ctr.readStdin) {
 			await this.getStdin();
 		}
 	}
+
+	protected outputMessage = output.outputMessage;
+	protected outputData = output.outputData;
 }

lib/commands/build.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2016-2020 Balena Ltd.
+ * 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.
@@ -18,18 +18,23 @@
 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 { dockerignoreHelp, registrySecretsHelp } from '../utils/messages';
+import {
+	buildArgDeprecation,
+	dockerignoreHelp,
+	registrySecretsHelp,
+} from '../utils/messages';
 import type { ComposeCliFlags, ComposeOpts } from '../utils/compose-types';
-import { composeCliFlags } from '../utils/compose_ts';
-import type { DockerCliFlags } from '../utils/docker';
+import { buildProject, composeCliFlags } from '../utils/compose_ts';
+import type { BuildOpts, DockerCliFlags } from '../utils/docker';
 import { dockerCliFlags } from '../utils/docker';
 
 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;
 }
@@ -47,7 +52,7 @@ the provided docker daemon in your development machine or balena device.
 (See also the \`balena push\` command for the option of building images in the
 balenaCloud build servers.)
 
-You must provide either an application or a device-type/architecture pair.
+You must specify either a fleet, or the device type and architecture.
 
 This command will look into the given source directory (or the current working
 directory if one isn't specified) for a docker-compose.yml file, and if found,
@@ -61,12 +66,12 @@ ${registrySecretsHelp}
 ${dockerignoreHelp}
 `;
 	public static examples = [
-		'$ balena build --application myApp',
-		'$ balena build ./source/ --application myApp',
+		'$ balena build --fleet myFleet',
+		'$ balena build ./source/ --fleet myorg/myfleet',
 		'$ balena build --deviceType raspberrypi3 --arch armv7hf --emulated',
-		'$ balena build --docker /var/run/docker.sock --application myApp   # Linux, Mac',
-		'$ balena build --docker //./pipe/docker_engine --application myApp # Windows',
-		'$ balena build --dockerHost my.docker.host --dockerPort 2376 --ca ca.pem --key key.pem --cert cert.pem -a myApp',
+		'$ 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 = [
@@ -87,10 +92,7 @@ ${dockerignoreHelp}
 			description: 'the type of device this build is for',
 			char: 'd',
 		}),
-		application: flags.string({
-			description: 'name of the target balena application this build is for',
-			char: 'a',
-		}),
+		fleet: cf.fleet,
 		...composeCliFlags,
 		...dockerCliFlags,
 		// NOTE: Not supporting -h for help, because of clash with -h in DockerCliFlags
@@ -105,10 +107,8 @@ ${dockerignoreHelp}
 			BuildCmd,
 		);
 
-		await Command.checkLoggedInIf(!!options.application);
+		await Command.checkLoggedInIf(!!options.fleet);
 
-		// compositions with many services trigger misleading warnings
-		// @ts-ignore editing property that isn't typed but does exist
 		(await import('events')).defaultMaxListeners = 1000;
 
 		const sdk = getBalenaSdk();
@@ -122,6 +122,11 @@ ${dockerignoreHelp}
 
 		await this.validateOptions(options, sdk);
 
+		// Build args are under consideration for removal - warn user
+		if (options.buildArg) {
+			console.log(buildArgDeprecation);
+		}
+
 		const app = await this.getAppAndResolveArch(options);
 
 		const { docker, buildOpts, composeOpts } = await this.prepareBuild(options);
@@ -146,14 +151,12 @@ ${dockerignoreHelp}
 	protected async validateOptions(opts: FlagsDef, sdk: BalenaSDK) {
 		// Validate option combinations
 		if (
-			(opts.application == null &&
-				(opts.arch == null || opts.deviceType == null)) ||
-			(opts.application != null &&
-				(opts.arch != null || opts.deviceType != null))
+			(opts.fleet == null && (opts.arch == null || opts.deviceType == null)) ||
+			(opts.fleet != null && (opts.arch != null || opts.deviceType != null))
 		) {
 			const { ExpectedError } = await import('../errors');
 			throw new ExpectedError(
-				'You must specify either an application or an arch/deviceType pair to build for',
+				'You must specify either a fleet (-f), or the device type (-d) and architecture (-A)',
 			);
 		}
 
@@ -174,9 +177,9 @@ ${dockerignoreHelp}
 	}
 
 	protected async getAppAndResolveArch(opts: FlagsDef) {
-		if (opts.application) {
+		if (opts.fleet) {
 			const { getAppWithArch } = await import('../utils/helpers');
-			const app = await getAppWithArch(opts.application);
+			const app = await getAppWithArch(opts.fleet);
 			opts.arch = app.arch;
 			opts.deviceType = app.is_for__device_type[0].slug;
 			return app;
@@ -211,7 +214,7 @@ ${dockerignoreHelp}
 	 * @param opts
 	 */
 	protected async buildProject(
-		docker: import('docker-toolbelt'),
+		docker: import('dockerode'),
 		logger: import('../utils/logger'),
 		composeOpts: ComposeOpts,
 		opts: {
@@ -219,12 +222,17 @@ ${dockerignoreHelp}
 			arch: string;
 			deviceType: string;
 			buildEmulated: boolean;
-			buildOpts: any;
+			buildOpts: BuildOpts;
 		},
 	) {
 		const { loadProject } = await import('../utils/compose_ts');
 
-		const project = await loadProject(logger, composeOpts);
+		const project = await loadProject(
+			logger,
+			composeOpts,
+			undefined,
+			opts.buildOpts.t,
+		);
 
 		const appType = (opts.app?.application_type as ApplicationType[])?.[0];
 		if (
@@ -233,26 +241,25 @@ ${dockerignoreHelp}
 			!appType.supports_multicontainer
 		) {
 			logger.logWarn(
-				'Target application does not support multiple containers.\n' +
+				'Target fleet does not support multiple containers.\n' +
 					'Continuing with build, but you will not be able to deploy.',
 			);
 		}
 
-		await compose.buildProject(
+		await buildProject({
 			docker,
 			logger,
-			project.path,
-			project.name,
-			project.composition,
-			opts.arch,
-			opts.deviceType,
-			opts.buildEmulated,
-			opts.buildOpts,
-			composeOpts.inlineLogs,
-			composeOpts.convertEol,
-			composeOpts.dockerfilePath,
-			composeOpts.nogitignore,
-			composeOpts.multiDockerignore,
-		);
+			projectPath: project.path,
+			projectName: project.name,
+			composition: project.composition,
+			arch: opts.arch,
+			deviceType: opts.deviceType,
+			emulated: opts.buildEmulated,
+			buildOpts: opts.buildOpts,
+			inlineLogs: composeOpts.inlineLogs,
+			convertEol: composeOpts.convertEol,
+			dockerfilePath: composeOpts.dockerfilePath,
+			multiDockerignore: composeOpts.multiDockerignore,
+		});
 	}
 }

lib/commands/config/generate.ts

@@ -19,12 +19,13 @@ import { flags } from '@oclif/command';
 import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, getCliForm, stripIndent } from '../../utils/lazy';
-import type { Application, PineDeferred } from 'balena-sdk';
+import { applicationIdInfo, devModeInfo } from '../../utils/messages';
+import type { PineDeferred } from 'balena-sdk';
 
 interface FlagsDef {
 	version: string; // OS version
-	application?: string;
-	app?: string; // application alias
+	fleet?: string;
+	dev?: boolean; // balenaOS development variant
 	device?: string;
 	deviceApiKey?: string;
 	deviceType?: string;
@@ -35,6 +36,7 @@ interface FlagsDef {
 	wifiSsid?: string;
 	wifiKey?: string;
 	appUpdatePollInterval?: string;
+	'provisioning-key-name'?: string;
 	help: void;
 }
 
@@ -42,27 +44,30 @@ export default class ConfigGenerateCmd extends Command {
 	public static description = stripIndent`
 		Generate a config.json file.
 
-		Generate a config.json file for a device or application.
+		Generate a config.json file for a device or fleet.
 
-		Calling this command with the exact version number of the targeted image is required.
+		The target balenaOS version must be specified with the --version option.
 
-		This command is interactive by default, but you can do this automatically without interactivity
-		by specifying an option for each question on the command line, if you know the questions
-		that will be asked for the relevant device type.
+		${devModeInfo.split('\n').join('\n\t\t')}
 
-		In case that you want to configure an image for an application with mixed device types,
-		you can pass the --device-type argument along with --app to specify the target device type.
+		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.
+
+		To avoid interactive questions, specify a command line option for each question that
+		would otherwise be asked.
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
 	`;
 
 	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 --device-api-key <existingDeviceKey>',
+		'$ balena config generate --device 7cf02a6 --version 2.12.7 --deviceApiKey <existingDeviceKey>',
 		'$ balena config generate --device 7cf02a6 --version 2.12.7 --output config.json',
-		'$ balena config generate --app MyApp --version 2.12.7',
-		'$ balena config generate --app MyApp --version 2.12.7 --device-type fincm3',
-		'$ balena config generate --app MyApp --version 2.12.7 --output config.json',
-		'$ balena config generate --app MyApp --version 2.12.7 --network wifi --wifiSsid mySsid --wifiKey abcdefgh --appUpdatePollInterval 1',
+		'$ balena config generate --fleet myorg/fleet --version 2.12.7 --dev',
+		'$ 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',
 	];
 
 	public static usage = 'config generate';
@@ -72,27 +77,20 @@ export default class ConfigGenerateCmd extends Command {
 			description: 'a balenaOS version',
 			required: true,
 		}),
-		application: flags.string({
-			description: 'application name',
-			char: 'a',
-			exclusive: ['app', 'device'],
-		}),
-		app: flags.string({
-			description: "same as '--application'",
-			exclusive: ['application', 'device'],
-		}),
-		device: flags.string({
-			description: 'device uuid',
-			char: 'd',
-			exclusive: ['application', 'app'],
-		}),
+		fleet: { ...cf.fleet, exclusive: ['device'] },
+		dev: cf.dev,
+		device: {
+			...cf.device,
+			exclusive: ['fleet', 'provisioning-key-name'],
+		},
 		deviceApiKey: flags.string({
 			description:
 				'custom device key - note that this is only supported on balenaOS 2.0.3+',
 			char: 'k',
 		}),
 		deviceType: flags.string({
-			description: 'device type slug',
+			description:
+				"device type slug (run 'balena devices supported' for possible values)",
 		}),
 		'generate-device-api-key': flags.boolean({
 			description: 'generate a fresh device key for the device',
@@ -116,7 +114,11 @@ export default class ConfigGenerateCmd extends Command {
 		}),
 		appUpdatePollInterval: flags.string({
 			description:
-				'how frequently (in minutes) to poll for application updates',
+				'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'],
 		}),
 		help: cf.help,
 	};
@@ -126,38 +128,53 @@ export default class ConfigGenerateCmd extends Command {
 	public async run() {
 		const { flags: options } = this.parse<FlagsDef, {}>(ConfigGenerateCmd);
 
+		const { getApplication } = await import('../../utils/sdk');
+
 		const balena = getBalenaSdk();
 
 		await this.validateOptions(options);
 
-		let deviceType = options.deviceType;
-		// Get device | application
-		let resource;
+		let resourceDeviceType: string;
+		let application: ApplicationWithDeviceType | null = null;
+		let device:
+			| (DeviceWithDeviceType & { belongs_to__application: PineDeferred })
+			| null = null;
 		if (options.device != null) {
 			const { tryAsInteger } = await import('../../utils/validation');
-			resource = (await balena.models.device.get(tryAsInteger(options.device), {
-				$expand: {
-					is_of__device_type: { $select: 'slug' },
-				},
-			})) as DeviceWithDeviceType & { belongs_to__application: PineDeferred };
-			deviceType = deviceType || resource.is_of__device_type[0].slug;
+			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`
+					Device ${options.device} does not appear to belong to an accessible fleet.
+					Try with a different device, or use '--fleet' instead of '--device'.`);
+			}
+			device = rawDevice as DeviceWithDeviceType & {
+				belongs_to__application: PineDeferred;
+			};
+			resourceDeviceType = device.is_of__device_type[0].slug;
 		} else {
-			resource = (await balena.models.application.get(options.application!, {
+			// Disambiguate application (if is a number, it could either be an ID or a numerical name)
+			application = (await getApplication(balena, options.fleet!, {
 				$expand: {
 					is_for__device_type: { $select: 'slug' },
 				},
 			})) as ApplicationWithDeviceType;
-			deviceType = deviceType || resource.is_for__device_type[0].slug;
+			resourceDeviceType = application.is_for__device_type[0].slug;
 		}
 
+		const deviceType = options.deviceType || resourceDeviceType;
+
 		const deviceManifest = await balena.models.device.getManifestBySlug(
-			deviceType!,
+			deviceType,
 		);
 
 		// Check compatibility if application and deviceType provided
-		if (options.application && options.deviceType) {
+		if (options.fleet && options.deviceType) {
 			const appDeviceManifest = await balena.models.device.getManifestBySlug(
-				deviceType!,
+				resourceDeviceType,
 			);
 
 			const helpers = await import('../../utils/helpers');
@@ -165,7 +182,7 @@ export default class ConfigGenerateCmd extends Command {
 				!helpers.areDeviceTypesCompatible(appDeviceManifest, deviceManifest)
 			) {
 				throw new balena.errors.BalenaInvalidDeviceType(
-					`Device type ${options.deviceType} is incompatible with application ${options.application}`,
+					`Device type ${options.deviceType} is incompatible with fleet ${options.fleet}`,
 				);
 			}
 		}
@@ -174,9 +191,11 @@ export default class ConfigGenerateCmd extends Command {
 		// 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,
+			override: { ...options, app: options.fleet, application: options.fleet },
 		});
 		answers.version = options.version;
+		answers.developmentMode = options.dev;
+		answers.provisioningKeyName = options['provisioning-key-name'];
 
 		// Generate config
 		const { generateDeviceConfig, generateApplicationConfig } = await import(
@@ -184,18 +203,15 @@ export default class ConfigGenerateCmd extends Command {
 		);
 
 		let config;
-		if ('uuid' in resource && resource.uuid != null) {
+		if (device) {
 			config = await generateDeviceConfig(
-				resource,
+				device,
 				options.deviceApiKey || options['generate-device-api-key'] || undefined,
 				answers,
 			);
-		} else {
+		} else if (application) {
 			answers.deviceType = deviceType;
-			config = await generateApplicationConfig(
-				resource as Application,
-				answers,
-			);
+			config = await generateApplicationConfig(application, answers);
 		}
 
 		// Output
@@ -209,38 +225,27 @@ export default class ConfigGenerateCmd extends Command {
 	}
 
 	protected readonly missingDeviceOrAppMessage = stripIndent`
-		Either a device or an application must be specified.
+		Either a device or a fleet must be specified.
 
 		See the help page for examples:
 
 		  $ balena help config generate
   	`;
 
-	protected readonly deviceTypeNotAllowedMessage = stripIndent`
-		Specifying a different device type is only supported when
-		generating a config for an application:
-
-		* An application, with --app <appname>
-		* A specific device type, with --device-type <deviceTypeSlug>
-
-		See the help page for examples:
-
-		  $ balena help config generate
-	`;
+	protected readonly deviceTypeNotAllowedMessage =
+		'The --deviceType option can only be used alongside the --fleet option';
 
 	protected async validateOptions(options: FlagsDef) {
 		const { ExpectedError } = await import('../../errors');
 
-		// Prefer options.application over options.app
-		options.application = options.application || options.app;
-		delete options.app;
-
-		if (options.device == null && options.application == null) {
+		if (options.device == null && options.fleet == null) {
 			throw new ExpectedError(this.missingDeviceOrAppMessage);
 		}
 
-		if (!options.application && options.deviceType) {
+		if (!options.fleet && options.deviceType) {
 			throw new ExpectedError(this.deviceTypeNotAllowedMessage);
 		}
+		const { validateDevOptionAndWarn } = await import('../../utils/config');
+		await validateDevOptionAndWarn(options.dev, options.version);
 	}
 }

lib/commands/config/inject.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2016-2020 Balena Ltd.
+ * 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.
@@ -21,7 +21,7 @@ import * as cf from '../../utils/common-flags';
 import { getVisuals, stripIndent } from '../../utils/lazy';
 
 interface FlagsDef {
-	type: string;
+	type?: string;
 	drive?: string;
 	help: void;
 }
@@ -32,15 +32,18 @@ interface ArgsDef {
 
 export default class ConfigInjectCmd extends Command {
 	public static description = stripIndent`
-		Inject a configuration file into a device or OS image.
+		Inject a config.json file to a balenaOS image or attached media.
 
-		Inject a config.json file to the mounted filesystem,
-		e.g. the SD card of a provisioned device or balenaOS image.
+		Inject a 'config.json' file to 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/
 	`;
 
 	public static examples = [
-		'$ balena config inject my/config.json --type raspberrypi3',
-		'$ balena config inject my/config.json --type raspberrypi3 --drive /dev/disk2',
+		'$ balena config inject my/config.json',
+		'$ balena config inject my/config.json --drive /dev/disk2',
 	];
 
 	public static args = [
@@ -54,34 +57,24 @@ export default class ConfigInjectCmd extends Command {
 	public static usage = 'config inject <file>';
 
 	public static flags: flags.Input<FlagsDef> = {
-		type: flags.string({
-			description:
-				'device type (Check available types with `balena devices supported`)',
-			char: 't',
-			required: true,
-		}),
-		drive: flags.string({
-			description: 'device filesystem or OS image location',
-			char: 'd',
-		}),
+		...cf.deviceTypeIgnored,
+		drive: cf.driveOrImg,
 		help: cf.help,
 	};
 
-	public static authenticated = true;
-
 	public static root = true;
+	public static offlineCompatible = true;
 
 	public async run() {
 		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
 			ConfigInjectCmd,
 		);
 
-		const { promisify } = await import('util');
-		const umountAsync = promisify((await import('umount')).umount);
+		const { safeUmount } = await import('../../utils/umount');
 
 		const drive =
 			options.drive || (await getVisuals().drive('Select the device/OS drive'));
-		await umountAsync(drive);
+		await safeUmount(drive);
 
 		const fs = await import('fs');
 		const configJSON = JSON.parse(
@@ -89,7 +82,7 @@ export default class ConfigInjectCmd extends Command {
 		);
 
 		const config = await import('balena-config-json');
-		await config.write(drive, options.type, configJSON);
+		await config.write(drive, '', configJSON);
 
 		console.info('Done');
 	}

lib/commands/config/read.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2016-2020 Balena Ltd.
+ * 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.
@@ -21,58 +21,58 @@ import * as cf from '../../utils/common-flags';
 import { getVisuals, stripIndent } from '../../utils/lazy';
 
 interface FlagsDef {
-	type: string;
+	type?: string;
 	drive?: string;
 	help: void;
+	json: boolean;
 }
 
 export default class ConfigReadCmd extends Command {
 	public static description = stripIndent`
-		Read the configuration of a device or OS image.
+		Read the config.json file of a balenaOS image or attached media.
 
-		Read the config.json file from the mounted filesystem,
-		e.g. the SD card of a provisioned device or balenaOS 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/
 	`;
 
 	public static examples = [
-		'$ balena config read --type raspberrypi3',
-		'$ balena config read --type raspberrypi3 --drive /dev/disk2',
+		'$ balena config read',
+		'$ balena config read --drive /dev/disk2',
+		'$ balena config read --drive balena.img',
 	];
 
 	public static usage = 'config read';
 
 	public static flags: flags.Input<FlagsDef> = {
-		type: flags.string({
-			description:
-				'device type (Check available types with `balena devices supported`)',
-			char: 't',
-			required: true,
-		}),
-		drive: flags.string({
-			description: 'device filesystem or OS image location',
-			char: 'd',
-		}),
+		...cf.deviceTypeIgnored,
+		drive: cf.driveOrImg,
 		help: cf.help,
+		json: cf.json,
 	};
 
-	public static authenticated = true;
-
 	public static root = true;
+	public static offlineCompatible = true;
 
 	public async run() {
 		const { flags: options } = this.parse<FlagsDef, {}>(ConfigReadCmd);
 
-		const { promisify } = await import('util');
-		const umountAsync = promisify((await import('umount')).umount);
+		const { safeUmount } = await import('../../utils/umount');
 
 		const drive =
 			options.drive || (await getVisuals().drive('Select the device drive'));
-		await umountAsync(drive);
+		await safeUmount(drive);
 
 		const config = await import('balena-config-json');
-		const configJSON = await config.read(drive, options.type);
+		const configJSON = await config.read(drive, '');
 
-		const prettyjson = await import('prettyjson');
-		console.info(prettyjson.render(configJSON));
+		if (options.json) {
+			console.log(JSON.stringify(configJSON, null, 4));
+		} else {
+			const prettyjson = await import('prettyjson');
+			console.log(prettyjson.render(configJSON));
+		}
 	}
 }

lib/commands/config/reconfigure.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2016-2020 Balena Ltd.
+ * 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.
@@ -21,63 +21,74 @@ import * as cf from '../../utils/common-flags';
 import { getVisuals, stripIndent } from '../../utils/lazy';
 
 interface FlagsDef {
-	type: string;
+	type?: string;
 	drive?: string;
 	advanced: boolean;
 	help: void;
+	version?: string;
 }
 
 export default class ConfigReconfigureCmd extends Command {
 	public static description = stripIndent`
-		Interactively reconfigure a device or OS image.
+		Interactively reconfigure a balenaOS image file or attached media.
 
-		Interactively reconfigure a provisioned 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.
 `;
 	public static examples = [
-		'$ balena config reconfigure --type raspberrypi3',
-		'$ balena config reconfigure --type raspberrypi3 --advanced',
-		'$ balena config reconfigure --type raspberrypi3 --drive /dev/disk2',
+		'$ balena config reconfigure',
+		'$ balena config reconfigure --drive /dev/disk3',
+		'$ balena config reconfigure --drive balena.img --advanced',
 	];
 
 	public static usage = 'config reconfigure';
 
 	public static flags: flags.Input<FlagsDef> = {
-		type: flags.string({
-			description:
-				'device type (Check available types with `balena devices supported`)',
-			char: 't',
-			required: true,
-		}),
-		drive: flags.string({
-			description: 'device filesystem or OS image location',
-			char: 'd',
-		}),
+		...cf.deviceTypeIgnored,
+		drive: cf.driveOrImg,
 		advanced: flags.boolean({
 			description: 'show advanced commands',
 			char: 'v',
 		}),
 		help: cf.help,
+		version: flags.string({
+			description: 'balenaOS version, for example "2.32.0" or "2.44.0+rev1"',
+		}),
 	};
 
 	public static authenticated = true;
-
 	public static root = true;
 
 	public async run() {
 		const { flags: options } = this.parse<FlagsDef, {}>(ConfigReconfigureCmd);
 
-		const { promisify } = await import('util');
-		const umountAsync = promisify((await import('umount')).umount);
+		const { safeUmount } = await import('../../utils/umount');
 
 		const drive =
 			options.drive || (await getVisuals().drive('Select the device drive'));
-		await umountAsync(drive);
+		await safeUmount(drive);
 
 		const config = await import('balena-config-json');
-		const { uuid } = await config.read(drive, options.type);
-		await umountAsync(drive);
+		const { uuid } = await config.read(drive, '');
+		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

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2016-2020 Balena Ltd.
+ * 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.
@@ -21,7 +21,7 @@ import * as cf from '../../utils/common-flags';
 import { getVisuals, stripIndent } from '../../utils/lazy';
 
 interface FlagsDef {
-	type: string;
+	type?: string;
 	drive?: string;
 	help: void;
 }
@@ -33,16 +33,19 @@ interface ArgsDef {
 
 export default class ConfigWriteCmd extends Command {
 	public static description = stripIndent`
-		Write a key-value pair to configuration of a device or OS image.
+		Write a key-value pair to the config.json file of an OS image or attached media.
 
-		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.
+		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/
 	`;
 
 	public static examples = [
-		'$ 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 "..."',
+		'$ 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',
 	];
 
 	public static args = [
@@ -61,46 +64,46 @@ export default class ConfigWriteCmd extends Command {
 	public static usage = 'config write <key> <value>';
 
 	public static flags: flags.Input<FlagsDef> = {
-		type: flags.string({
-			description:
-				'device type (Check available types with `balena devices supported`)',
-			char: 't',
-			required: true,
-		}),
-		drive: flags.string({
-			description: 'device filesystem or OS image location',
-			char: 'd',
-		}),
+		...cf.deviceTypeIgnored,
+		drive: cf.driveOrImg,
 		help: cf.help,
 	};
 
-	public static authenticated = true;
-
 	public static root = true;
+	public static offlineCompatible = true;
 
 	public async run() {
 		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
 			ConfigWriteCmd,
 		);
 
-		const { promisify } = await import('util');
-		const umountAsync = promisify((await import('umount')).umount);
+		const { denyMount, safeUmount } = await import('../../utils/umount');
 
 		const drive =
 			options.drive || (await getVisuals().drive('Select the device drive'));
-		await umountAsync(drive);
+		await safeUmount(drive);
 
 		const config = await import('balena-config-json');
-		const configJSON = await config.read(drive, options.type);
+		const configJSON = await config.read(drive, '');
 
 		console.info(`Setting ${params.key} to ${params.value}`);
-		const _ = await import('lodash');
-		_.set(configJSON, params.key, params.value);
+		ConfigWriteCmd.updateConfigJson(configJSON, params.key, params.value);
 
-		await umountAsync(drive);
-
-		await config.write(drive, options.type, configJSON);
+		await denyMount(drive, async () => {
+			await safeUmount(drive);
+			await config.write(drive, '', configJSON);
+		});
 
 		console.info('Done');
 	}
+
+	/** Call Lodash's _.setWith(). Moved here for ease of testing. */
+	static updateConfigJson(configJSON: object, key: string, value: string) {
+		const _ = require('lodash') as typeof import('lodash');
+		// note: _.setWith() is needed instead of _.set() because, given a key
+		// like `os.udevRules.101`, _.set() creates a udevRules array (rather
+		// than a dictionary) and sets the 101st array element to value, while
+		// we actually want udevRules to be dictionary like { '101': value }
+		_.setWith(configJSON, key, value, (v) => v || {});
+	}
 }

lib/commands/deploy.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2016-2020 Balena Ltd.
+ * 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.
@@ -16,16 +16,39 @@
  */
 
 import { flags } from '@oclif/command';
+import type { ImageDescriptor } from 'resin-compose-parse';
+
 import Command from '../command';
 import { ExpectedError } from '../errors';
-import { getBalenaSdk, getChalk } from '../utils/lazy';
-import { dockerignoreHelp, registrySecretsHelp } from '../utils/messages';
+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';
-import type { ComposeCliFlags, ComposeOpts } from '../utils/compose-types';
-import type { DockerCliFlags } from '../utils/docker';
-import { composeCliFlags } from '../utils/compose_ts';
+import type {
+	BuiltImage,
+	ComposeCliFlags,
+	ComposeOpts,
+	Release as ComposeReleaseInfo,
+} 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 { Application, ApplicationType, DeviceType } from 'balena-sdk';
+import type {
+	Application,
+	ApplicationType,
+	DeviceType,
+	Release,
+} from 'balena-sdk';
 
 interface ApplicationWithArch extends Application {
 	arch: string;
@@ -35,22 +58,24 @@ interface FlagsDef extends ComposeCliFlags, DockerCliFlags {
 	source?: string;
 	build: boolean;
 	nologupload: boolean;
+	'release-tag'?: string[];
+	draft: boolean;
 	help: void;
 }
 
 interface ArgsDef {
-	appName: string;
+	fleet: string;
 	image?: string;
 }
 
 export default class DeployCmd extends Command {
 	public static description = `\
-Deploy a single image or a multicontainer project to a balena application.
+Deploy a single image or a multicontainer project to a balena fleet.
 
-Usage: \`deploy <appName> ([image] | --build [--source build-dir])\`
+Usage: \`deploy <fleet> ([image] | --build [--source build-dir])\`
 
-Use this command to deploy an image or a complete multicontainer project to an
-application, optionally building it first. The source images are searched for
+Use this command to deploy an image or a complete multicontainer project to a
+fleet, optionally building it first. The source images are searched for
 (and optionally built) using the docker daemon in your development machine or
 balena device. (See also the \`balena push\` command for the option of building
 the image in the balenaCloud build servers.)
@@ -58,13 +83,15 @@ the image in the balenaCloud build servers.)
 Unless an image is specified, this command will look into the current directory
 (or the one specified by --source) for a docker-compose.yml file.  If one is
 found, this command will deploy each service defined in the compose file,
-building it first if an image for it doesn't exist. If a compose file isn't
-found, the command will look for a Dockerfile[.template] file (or alternative
-Dockerfile specified with the \`-f\` option), and if yet that isn't found, it
-will try to generate one.
+building it first if an image for it doesn't exist. Image names will be looked
+up according to the scheme: \`<projectName>_<serviceName>\`.
 
-To deploy to an app on which you're a collaborator, use
-\`balena deploy <appOwnerUsername>/<appName>\`.
+If a compose file isn't found, the command will look for a Dockerfile[.template]
+file (or alternative Dockerfile specified with the \`-f\` option), and if yet
+that isn't found, it will try to generate one.
+
+To deploy to a fleet where you are a collaborator, use fleet slug including the
+organization:  \`balena deploy <organization>/<fleet>\`.
 
 ${registrySecretsHelp}
 
@@ -72,25 +99,22 @@ ${dockerignoreHelp}
 `;
 
 	public static examples = [
-		'$ balena deploy myApp',
-		'$ balena deploy myApp --build --source myBuildDir/',
-		'$ balena deploy myApp myApp/myImage',
+		'$ balena deploy myFleet',
+		'$ balena deploy myorg/myfleet --build --source myBuildDir/',
+		'$ balena deploy myorg/myfleet myRepo/myImage',
+		'$ balena deploy myFleet myRepo/myImage --release-tag key1 "" key2 "value2 with spaces"',
 	];
 
 	public static args = [
-		{
-			name: 'appName',
-			description: 'the name of the application to deploy to',
-			required: true,
-		},
+		ca.fleetRequired,
 		{
 			name: 'image',
 			description: 'the image to deploy',
 		},
 	];
 
-	public static usage = 'deploy <appName> [image]';
-
+	public static usage = 'deploy <fleet> [image]';
+	// TODO:  docker-compose naming
 	public static flags: flags.Input<FlagsDef> = {
 		source: flags.string({
 			description:
@@ -105,6 +129,22 @@ ${dockerignoreHelp}
 			description:
 				"don't upload build logs to the dashboard with image (if building)",
 		}),
+		'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).
+				Hint: Empty values may be specified with "" (bash, cmd.exe) or '""' (PowerShell).
+			`,
+			multiple: true,
+		}),
+		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.
+				Draft releases can be marked as final through the API. Releases are created
+				as final by default unless this option is given.`,
+			default: false,
+		}),
 		...composeCliFlags,
 		...dockerCliFlags,
 		// NOTE: Not supporting -h for help, because of clash with -h in DockerCliFlags
@@ -121,14 +161,17 @@ ${dockerignoreHelp}
 			DeployCmd,
 		);
 
-		// compositions with many services trigger misleading warnings
-		// @ts-ignore editing property that isn't typed but does exist
 		(await import('events')).defaultMaxListeners = 1000;
 
 		const logger = await Command.getLogger();
 		logger.logDebug('Parsing input...');
 
-		const { appName, image } = params;
+		const { fleet, image } = params;
+
+		// Build args are under consideration for removal - warn user
+		if (options.buildArg) {
+			console.log(buildArgDeprecation);
+		}
 
 		if (image != null && options.build) {
 			throw new ExpectedError(
@@ -141,27 +184,29 @@ ${dockerignoreHelp}
 			'../utils/compose_ts'
 		);
 
+		const { releaseTagKeys, releaseTagValues } = parseReleaseTagKeysAndValues(
+			options['release-tag'] ?? [],
+		);
+
 		if (image) {
 			options['registry-secrets'] = await getRegistrySecrets(
 				sdk,
 				options['registry-secrets'],
 			);
 		} else {
-			const {
-				dockerfilePath,
-				registrySecrets,
-			} = await validateProjectDirectory(sdk, {
-				dockerfilePath: options.dockerfile,
-				noParentCheck: options['noparent-check'] || false,
-				projectPath: options.source || '.',
-				registrySecretsPath: options['registry-secrets'],
-			});
+			const { dockerfilePath, registrySecrets } =
+				await validateProjectDirectory(sdk, {
+					dockerfilePath: options.dockerfile,
+					noParentCheck: options['noparent-check'] || false,
+					projectPath: options.source || '.',
+					registrySecretsPath: options['registry-secrets'],
+				});
 			options.dockerfile = dockerfilePath;
 			options['registry-secrets'] = registrySecrets;
 		}
 
 		const helpers = await import('../utils/helpers');
-		const app = await helpers.getAppWithArch(appName);
+		const app = await helpers.getAppWithArch(fleet);
 
 		const dockerUtils = await import('../utils/docker');
 		const [docker, buildOpts, composeOpts] = await Promise.all([
@@ -170,19 +215,26 @@ ${dockerignoreHelp}
 			compose.generateOpts(options),
 		]);
 
-		await this.deployProject(docker, logger, composeOpts, {
+		const release = await this.deployProject(docker, logger, composeOpts, {
 			app,
-			appName, // may be prefixed by 'owner/', unlike app.app_name
+			appName: fleet, // may be prefixed by 'owner/', unlike app.app_name
 			image,
 			shouldPerformBuild: !!options.build,
 			shouldUploadLogs: !options.nologupload,
 			buildEmulated: !!options.emulated,
+			createAsDraft: options.draft,
 			buildOpts,
 		});
+		await applyReleaseTagKeysAndValues(
+			sdk,
+			release.id,
+			releaseTagKeys,
+			releaseTagValues,
+		);
 	}
 
 	async deployProject(
-		docker: import('docker-toolbelt'),
+		docker: import('dockerode'),
 		logger: import('../utils/logger'),
 		composeOpts: ComposeOpts,
 		opts: {
@@ -193,7 +245,8 @@ ${dockerignoreHelp}
 			shouldPerformBuild: boolean;
 			shouldUploadLogs: boolean;
 			buildEmulated: boolean;
-			buildOpts: any; // arguments to forward to docker build command
+			buildOpts: BuildOpts;
+			createAsDraft: boolean;
 		},
 	) {
 		const _ = await import('lodash');
@@ -206,30 +259,34 @@ ${dockerignoreHelp}
 		const appType = (opts.app?.application_type as ApplicationType[])?.[0];
 
 		try {
-			const project = await loadProject(logger, composeOpts, opts.image);
+			const project = await loadProject(
+				logger,
+				composeOpts,
+				opts.image,
+				opts.buildOpts.t,
+			);
 			if (project.descriptors.length > 1 && !appType?.supports_multicontainer) {
 				throw new ExpectedError(
-					'Target application does not support multiple containers. Aborting!',
+					'Target fleet does not support multiple containers. Aborting!',
 				);
 			}
 
 			// find which services use images that already exist locally
-			let servicesToSkip = await Promise.all(
-				project.descriptors.map(async function (d: any) {
+			let servicesToSkip: string[] = await Promise.all(
+				project.descriptors.map(async function (d: ImageDescriptor) {
 					// unconditionally build (or pull) if explicitly requested
 					if (opts.shouldPerformBuild) {
-						return d;
+						return '';
 					}
 					try {
 						await docker
-							.getImage(
-								(typeof d.image === 'string' ? d.image : d.image.tag) || '',
-							)
+							.getImage((isBuildConfig(d.image) ? d.image.tag : d.image) || '')
 							.inspect();
 
 						return d.serviceName;
 					} catch {
 						// Ignore
+						return '';
 					}
 				}),
 			);
@@ -243,46 +300,45 @@ ${dockerignoreHelp}
 				compositionToBuild.services,
 				servicesToSkip,
 			);
+			let builtImagesByService: Dictionary<BuiltImage> = {};
 			if (_.size(compositionToBuild.services) === 0) {
 				logger.logInfo(
 					'Everything is up to date (use --build to force a rebuild)',
 				);
-				return {};
+			} else {
+				const builtImages = await buildProject({
+					docker,
+					logger,
+					projectPath: project.path,
+					projectName: project.name,
+					composition: compositionToBuild,
+					arch: opts.app.arch,
+					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,
+					multiDockerignore: composeOpts.multiDockerignore,
+				});
+				builtImagesByService = _.keyBy(builtImages, 'serviceName');
 			}
-			const builtImages = await compose.buildProject(
-				docker,
-				logger,
-				project.path,
-				project.name,
-				compositionToBuild,
-				opts.app.arch,
-				(opts.app?.is_for__device_type as DeviceType[])?.[0].slug,
-				opts.buildEmulated,
-				opts.buildOpts,
-				composeOpts.inlineLogs,
-				composeOpts.convertEol,
-				composeOpts.dockerfilePath,
-				composeOpts.nogitignore,
-				composeOpts.multiDockerignore,
-			);
-			const builtImagesByService = _.keyBy(builtImages, 'serviceName');
-
-			const images = project.descriptors.map(
+			const images: BuiltImage[] = project.descriptors.map(
 				(d) =>
 					builtImagesByService[d.serviceName] ?? {
 						serviceName: d.serviceName,
-						name: typeof d.image === 'string' ? d.image : d.image.tag,
+						name: (isBuildConfig(d.image) ? d.image.tag : d.image) || '',
 						logs: 'Build skipped; image for service already exists.',
 						props: {},
 					},
 			);
 
-			let release;
+			let release: Release | ComposeReleaseInfo['release'];
 			if (appType?.is_legacy) {
 				const { deployLegacy } = require('../utils/deploy-legacy');
 
 				const msg = getChalk().yellow(
-					'Target application requires legacy deploy method.',
+					'Target fleet requires legacy deploy method.',
 				);
 				logger.logWarn(msg);
 
@@ -326,6 +382,8 @@ ${dockerignoreHelp}
 					`Bearer ${auth}`,
 					apiEndpoint,
 					!opts.shouldUploadLogs,
+					composeOpts.projectPath,
+					opts.createAsDraft,
 				);
 			}
 
@@ -335,6 +393,7 @@ ${dockerignoreHelp}
 			console.log();
 			console.log(doodles.getDoodle()); // Show charlie
 			console.log();
+			return release;
 		} catch (err) {
 			logger.logError('Deploy failed');
 			throw err;

lib/commands/device/deactivate.ts

@@ -0,0 +1,87 @@
+/**
+ * @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 { 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.
+
+		Deactivate a device.
+
+		Note this command asks for confirmation interactively.
+		You can avoid this by passing the \`--yes\` option.
+		`;
+	public static examples = [
+		'$ balena device deactivate 7cf02a6',
+		'$ balena device deactivate 7cf02a6 --yes',
+	];
+
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
+			description: 'the UUID of the device to be deactivated',
+			required: true,
+		},
+	];
+
+	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 } = this.parse<FlagsDef, ArgsDef>(
+			DeviceDeactivateCmd,
+		);
+
+		const balena = getBalenaSdk();
+		const patterns = await import('../../utils/patterns');
+
+		const uuid = params.uuid;
+		const deactivationWarning = `
+Warning! Deactivating a device will charge a fee equivalent to the
+normal monthly cost for the device (e.g. $1 for an essentials device);
+the device will not be charged again until it comes online.
+`;
+
+		const warning = `Are you sure you want to deactivate device ${uuid} ?`;
+
+		console.error(deactivationWarning);
+		// Confirm
+		await patterns.confirm(options.yes, warning);
+		// Deactivate
+		await balena.models.device.deactivate(uuid);
+	}
+}

lib/commands/device/index.ts

@@ -22,11 +22,12 @@ import * as cf from '../../utils/common-flags';
 import { expandForAppName } from '../../utils/helpers';
 import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
 import { tryAsInteger } from '../../utils/validation';
+
 import type { Application, Release } from 'balena-sdk';
 
 interface ExtendedDevice extends DeviceWithDeviceType {
 	dashboard_url?: string;
-	application_name?: string;
+	fleet: string; // 'org/name' slug
 	device_type?: string;
 	commit?: string;
 	last_seen?: string;
@@ -96,6 +97,7 @@ export default class DeviceCmd extends Command {
 				'os_version',
 				'memory_usage',
 				'memory_total',
+				'public_address',
 				'storage_block_device',
 				'storage_usage',
 				'storage_total',
@@ -110,13 +112,17 @@ export default class DeviceCmd extends Command {
 
 		device.dashboard_url = balena.models.device.getDashboardUrl(device.uuid);
 
-		const belongsToApplication = device.belongs_to__application as Application[];
-		device.application_name = belongsToApplication?.[0]
-			? belongsToApplication[0].app_name
+		const belongsToApplication =
+			device.belongs_to__application as Application[];
+		device.fleet = belongsToApplication?.[0]
+			? belongsToApplication[0].slug
 			: 'N/a';
 
 		device.device_type = device.is_of__device_type[0].slug;
-		device.commit = (device.is_running__release as Release[])[0].commit;
+
+		const isRunningRelease = device.is_running__release as Release[];
+		device.commit = isRunningRelease?.[0] ? isRunningRelease[0].commit : 'N/a';
+
 		device.last_seen = device.last_connectivity_event ?? undefined;
 
 		// Memory/Storage are really MiB
@@ -165,8 +171,9 @@ export default class DeviceCmd extends Command {
 				'status',
 				'is_online',
 				'ip_address',
+				'public_address',
 				'mac_address',
-				'application_name',
+				'fleet',
 				'last_seen',
 				'uuid',
 				'commit',

lib/commands/device/init.ts

@@ -19,39 +19,63 @@ 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 { runCommand } from '../../utils/helpers';
 
 interface FlagsDef {
-	application?: string;
-	app?: string;
+	fleet?: string;
 	yes: boolean;
 	advanced: boolean;
 	'os-version'?: string;
 	drive?: string;
 	config?: string;
 	help: void;
+	'provisioning-key-name'?: string;
 }
 
 export default class DeviceInitCmd extends Command {
 	public static description = stripIndent`
-		Initialise a device with balenaOS.
+		Initialize a device with balenaOS.
 
-		Initialise a device by downloading the OS image of a certain application
-		and writing it to an SD Card.
+		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:
+
+		'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 fleets'  
+		'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.
+
+		${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.
+	`;
 
-		Note, if the application option is omitted it will be prompted
-		for interactively.
-		`;
 	public static examples = [
 		'$ balena device init',
-		'$ balena device init --application MyApp',
+		'$ balena device init -f myorg/myfleet',
+		'$ balena device init --fleet myFleet --os-version 2.83.21+rev1.prod --drive /dev/disk5 --config config.json --yes',
 	];
 
 	public static usage = 'device init';
 
 	public static flags: flags.Input<FlagsDef> = {
-		application: cf.application,
-		app: cf.app,
+		fleet: cf.fleet,
 		yes: cf.yes,
 		advanced: flags.boolean({
 			char: 'v',
@@ -70,6 +94,9 @@ export default class DeviceInitCmd extends Command {
 		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',
+		}),
 		help: cf.help,
 	};
 
@@ -84,20 +111,19 @@ export default class DeviceInitCmd extends Command {
 		const tmp = await import('tmp');
 		const tmpNameAsync = promisify(tmp.tmpName);
 		tmp.setGracefulCleanup();
-		const balena = getBalenaSdk();
 		const { downloadOSImage } = await import('../../utils/cloud');
-		const Logger = await import('../../utils/logger');
+		const { getApplication } = await import('../../utils/sdk');
 
-		const logger = Logger.getLogger();
-
-		// Consolidate application options
-		options.application = options.application || options.app;
-		delete options.app;
+		const logger = await Command.getLogger();
+		const balena = getBalenaSdk();
 
 		// Get application and
-		const application = (await balena.models.application.get(
-			options['application'] ||
-				(await (await import('../../utils/patterns')).selectApplication()),
+		const application = (await getApplication(
+			balena,
+			options.fleet ||
+				(
+					await (await import('../../utils/patterns')).selectApplication()
+				).id,
 			{
 				$expand: {
 					is_for__device_type: {
@@ -109,7 +135,7 @@ export default class DeviceInitCmd extends Command {
 
 		// Register new device
 		const deviceUuid = balena.models.device.generateUniqueKey();
-		console.info(`Registering to ${application.app_name}: ${deviceUuid}`);
+		console.info(`Registering to ${application.slug}: ${deviceUuid}`);
 		await balena.models.device.register(application.id, deviceUuid);
 		const device = await balena.models.device.get(deviceUuid);
 
@@ -152,6 +178,13 @@ 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'],
+			);
+		}
 		await runCommand(configureCommand);
 	}
 

lib/commands/device/local-mode.ts

@@ -0,0 +1,114 @@
+/**
+ * @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 { 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`
+		Get or manage the local mode status for a device.
+
+		Output current local mode status, or enable/disable local mode
+		for specified device.
+	`;
+
+	public static examples = [
+		'$ balena device local-mode 23c73a1',
+		'$ balena device local-mode 23c73a1 --enable',
+		'$ balena device local-mode 23c73a1 --disable',
+		'$ balena device local-mode 23c73a1 --status',
+	];
+
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
+			description: 'the uuid of the device to manage',
+			parse: (dev) => tryAsInteger(dev),
+			required: true,
+		},
+	];
+
+	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({
+			description: 'disable local mode',
+			exclusive: ['enable', 'status'],
+		}),
+		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 } = this.parse<FlagsDef, ArgsDef>(
+			DeviceLocalModeCmd,
+		);
+
+		const balena = getBalenaSdk();
+
+		if (options.enable) {
+			await balena.models.device.enableLocalMode(params.uuid);
+			console.log(`Local mode on device ${params.uuid} is now ENABLED.`);
+		} else if (options.disable) {
+			await balena.models.device.disableLocalMode(params.uuid);
+			console.log(`Local mode on device ${params.uuid} is now DISABLED.`);
+		} else if (options.status) {
+			// Output bool indicating local mode status
+			const isEnabled = await balena.models.device.isInLocalMode(params.uuid);
+			console.log(isEnabled);
+		} else {
+			// If no flag provided, output status and tip
+			const isEnabled = await balena.models.device.isInLocalMode(params.uuid);
+			console.log(
+				`Local mode on device ${params.uuid} is ${
+					isEnabled ? 'ENABLED' : 'DISABLED'
+				}.`,
+			);
+			if (isEnabled) {
+				console.log('To disable, use:');
+				console.log(`  balena device local-mode ${params.uuid} --disable`);
+			} else {
+				console.log('To enable, use:');
+				console.log(`  balena device local-mode ${params.uuid} --enable`);
+			}
+		}
+	}
+}

lib/commands/device/move.ts

@@ -0,0 +1,199 @@
+/**
+ * @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 } from '../../utils/messages';
+
+type ExtendedDevice = PineTypedResult<
+	Device,
+	typeof import('../../utils/helpers').expandForAppNameAndCpuArch
+> & {
+	application_name?: string;
+};
+
+interface FlagsDef {
+	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> = {
+		fleet: cf.fleet,
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+
+	public async run() {
+		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
+			DeviceMoveCmd,
+		);
+
+		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.fleet
+			? await getApplication(balena, options.fleet)
+			: 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

@@ -79,19 +79,15 @@ export default class DeviceOsUpdateCmd extends Command {
 		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',
+		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;
+			})) as DeviceWithDeviceType;
 
 		// Get current device OS version
 		const currentOsVersion = sdk.models.device.getOsVersion({

lib/commands/device/purge.ts

@@ -0,0 +1,80 @@
+/**
+ * @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, 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.
+
+		Purge data from a device.
+		This will clear the device's "/data" directory.
+
+		Multiple devices may be specified with a comma-separated list
+		of values (no spaces).
+		`;
+	public static examples = [
+		'$ balena device purge 23c73a1',
+		'$ balena device purge 55d43b3,23c73a1',
+	];
+
+	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 } = this.parse<FlagsDef, ArgsDef>(DevicePurgeCmd);
+
+		const { tryAsInteger } = await import('../../utils/validation');
+		const balena = getBalenaSdk();
+		const ux = getCliUx();
+
+		const deviceIds = params.uuid.split(',').map((id) => {
+			return tryAsInteger(id);
+		});
+
+		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/register.ts

@@ -19,8 +19,9 @@ 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 { tryAsInteger } from '../../utils/validation';
+import { applicationIdInfo } from '../../utils/messages';
 
 interface FlagsDef {
 	uuid?: string;
@@ -28,30 +29,29 @@ interface FlagsDef {
 }
 
 interface ArgsDef {
-	application: string;
+	fleet: string;
 }
 
 export default class DeviceRegisterCmd extends Command {
 	public static description = stripIndent`
-		Register a device.
+		Register a new device.
+
+		Register a new device with a balena fleet.
+
+		If --uuid is not provided, a new UUID will be automatically assigned.
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+	`;
 
-		Register a device to an application.
-		`;
 	public static examples = [
-		'$ balena device register MyApp',
-		'$ balena device register MyApp --uuid <uuid>',
+		'$ balena device register MyFleet',
+		'$ balena device register MyFleet --uuid <uuid>',
+		'$ balena device register myorg/myfleet --uuid <uuid>',
 	];
 
-	public static args: Array<IArg<any>> = [
-		{
-			name: 'application',
-			description: 'the name or id of application to register device with',
-			parse: (app) => tryAsInteger(app),
-			required: true,
-		},
-	];
+	public static args: Array<IArg<any>> = [ca.fleetRequired];
 
-	public static usage = 'device register <application>';
+	public static usage = 'device register <fleet>';
 
 	public static flags: flags.Input<FlagsDef> = {
 		uuid: flags.string({
@@ -68,12 +68,14 @@ export default class DeviceRegisterCmd extends Command {
 			DeviceRegisterCmd,
 		);
 
+		const { getApplication } = await import('../../utils/sdk');
+
 		const balena = getBalenaSdk();
 
-		const application = await balena.models.application.get(params.application);
+		const application = await getApplication(balena, params.fleet);
 		const uuid = options.uuid ?? balena.models.device.generateUniqueKey();
 
-		console.info(`Registering to ${application.app_name}: ${uuid}`);
+		console.info(`Registering to ${application.slug}: ${uuid}`);
 
 		const result = await balena.models.device.register(application.id, uuid);
 

lib/commands/device/restart.ts

@@ -0,0 +1,197 @@
+/**
+ * @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, getCliUx, stripIndent } from '../../utils/lazy';
+import type {
+	BalenaSDK,
+	DeviceWithServiceDetails,
+	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.
+
+		Restart containers on a device.
+		If the --service flag is provided, then only those services' containers
+		will be restarted, otherwise all containers on the device will be restarted.
+
+		Multiple devices and services may be specified with a comma-separated list
+		of values (no spaces).
+
+		Note this does not reboot the device, to do so use instead \`balena device reboot\`.
+		`;
+	public static examples = [
+		'$ balena device restart 23c73a1',
+		'$ balena device restart 55d43b3,23c73a1',
+		'$ balena device restart 23c73a1 --service myService',
+		'$ balena device restart 23c73a1 -s myService1,myService2',
+	];
+
+	public static args: Array<IArg<any>> = [
+		{
+			name: 'uuid',
+			description:
+				'comma-separated list (no blank spaces) of device UUIDs to restart',
+			required: true,
+		},
+	];
+
+	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 } = this.parse<FlagsDef, ArgsDef>(
+			DeviceRestartCmd,
+		);
+
+		const { tryAsInteger } = await import('../../utils/validation');
+		const balena = getBalenaSdk();
+		const ux = getCliUx();
+
+		const deviceIds = params.uuid.split(',').map((id) => {
+			return tryAsInteger(id);
+		});
+		const serviceNames = options.service?.split(',');
+
+		// Iterate sequentially through deviceIds.
+		// We may later want to add a batching feature,
+		// so that n devices are processed in parallel
+		for (const deviceId of deviceIds) {
+			ux.action.start(`Restarting services on device ${deviceId}`);
+			if (serviceNames) {
+				await this.restartServices(balena, deviceId, serviceNames);
+			} else {
+				await this.restartAllServices(balena, deviceId);
+			}
+			ux.action.stop();
+		}
+	}
+
+	async restartServices(
+		balena: BalenaSDK,
+		deviceId: number | string,
+		serviceNames: string[],
+	) {
+		const { ExpectedError, instanceOf } = await import('../../errors');
+		const { getExpandedProp } = await import('../../utils/pine');
+
+		// Get device
+		let device: DeviceWithServiceDetails<CurrentServiceWithCommit>;
+		try {
+			device = await balena.models.device.getWithServiceDetails(deviceId, {
+				$expand: {
+					is_running__release: { $select: 'commit' },
+				},
+			});
+		} catch (e) {
+			const { BalenaDeviceNotFound } = await import('balena-errors');
+			if (instanceOf(e, BalenaDeviceNotFound)) {
+				throw new ExpectedError(`Device ${deviceId} not found.`);
+			} else {
+				throw e;
+			}
+		}
+
+		const activeRelease = getExpandedProp(device.is_running__release, 'commit');
+
+		// Check specified services exist on this device before restarting anything
+		serviceNames.forEach((service) => {
+			if (!device.current_services[service]) {
+				throw new ExpectedError(
+					`Service ${service} not found on device ${deviceId}.`,
+				);
+			}
+		});
+
+		// Restart services
+		const restartPromises: Array<Promise<void>> = [];
+		for (const serviceName of serviceNames) {
+			const service = device.current_services[serviceName];
+			// Each service is an array of `CurrentServiceWithCommit`
+			// because when service is updating, it will actually hold 2 services
+			// Target commit matching `device.is_running__release`
+			const serviceContainer = service.find((s) => {
+				return s.commit === activeRelease;
+			});
+
+			if (serviceContainer) {
+				restartPromises.push(
+					balena.models.device.restartService(
+						deviceId,
+						serviceContainer.image_id,
+					),
+				);
+			}
+		}
+
+		try {
+			await Promise.all(restartPromises);
+		} catch (e) {
+			if (e.message.toLowerCase().includes('no online device')) {
+				throw new ExpectedError(`Device ${deviceId} is not online.`);
+			} else {
+				throw e;
+			}
+		}
+	}
+
+	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 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(deviceId);
+			if (!device.is_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 ${deviceId} not found.`);
+			} else {
+				throw e;
+			}
+		}
+
+		await balena.models.device.restartApplication(deviceId);
+	}
+}

lib/commands/device/rm.ts

@@ -51,7 +51,6 @@ export default class DeviceRmCmd extends Command {
 			name: 'uuid',
 			description:
 				'comma-separated list (no blank spaces) of device UUIDs to be removed',
-			parse: (dev) => tryAsInteger(dev),
 			required: true,
 		},
 	];
@@ -83,9 +82,9 @@ export default class DeviceRmCmd extends Command {
 		);
 
 		// Remove
-		for (const uuid of params.uuid.split(',')) {
+		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/devices/index.ts

@@ -20,17 +20,18 @@ import Command from '../../command';
 import * as cf from '../../utils/common-flags';
 import { expandForAppName } from '../../utils/helpers';
 import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
-import { tryAsInteger } from '../../utils/validation';
+import { applicationIdInfo, jsonInfo } from '../../utils/messages';
+
 import type { Application } from 'balena-sdk';
 
 interface ExtendedDevice extends DeviceWithDeviceType {
 	dashboard_url?: string;
-	application_name?: string;
+	fleet?: string | null; // 'org/name' slug
+	device_type?: string | null;
 }
 
 interface FlagsDef {
-	application?: string;
-	app?: string;
+	fleet?: string;
 	help: void;
 	json: boolean;
 }
@@ -39,32 +40,26 @@ export default class DevicesCmd extends Command {
 	public static description = stripIndent`
 		List all devices.
 
-		list all devices that belong to you.
+		List all of your devices.
 
-		You can filter the devices by application by using the \`--application\` option.
+		Devices can be filtered by fleet with the \`--fleet\` option.
 
-		The --json option is recommended when scripting the output of this command,
-		because field names are less likely to change in JSON format and because it
-		better represents data types like arrays and empty strings. The 'jq' utility
-		may also be helpful in shell scripts (https://stedolan.github.io/jq/manual/).
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+
+		${jsonInfo.split('\n').join('\n\t\t')}
 	`;
 	public static examples = [
 		'$ balena devices',
-		'$ balena devices --application MyApp',
-		'$ balena devices --app MyApp',
-		'$ balena devices -a MyApp',
+		'$ balena devices --fleet MyFleet',
+		'$ balena devices -f myorg/myfleet',
 	];
 
 	public static usage = 'devices';
 
 	public static flags: flags.Input<FlagsDef> = {
-		application: cf.application,
-		app: cf.app,
+		fleet: cf.fleet,
+		json: cf.json,
 		help: cf.help,
-		json: flags.boolean({
-			char: 'j',
-			description: 'produce JSON output instead of tabular output',
-		}),
 	};
 
 	public static primary = true;
@@ -76,15 +71,13 @@ export default class DevicesCmd extends Command {
 
 		const balena = getBalenaSdk();
 
-		// Consolidate application options
-		options.application = options.application || options.app;
-		delete options.app;
-
 		let devices;
 
-		if (options.application != null) {
+		if (options.fleet != null) {
+			const { getApplication } = await import('../../utils/sdk');
+			const application = await getApplication(balena, options.fleet);
 			devices = (await balena.models.device.getAllByApplication(
-				tryAsInteger(options.application),
+				application.id,
 				expandForAppName,
 			)) as ExtendedDevice[];
 		} else {
@@ -96,15 +89,13 @@ export default class DevicesCmd extends Command {
 		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]
-				? belongsToApplication[0].app_name
-				: 'N/a';
+			const belongsToApplication =
+				device.belongs_to__application as Application[];
+			device.fleet = belongsToApplication?.[0]?.slug || null;
 
-			device.uuid = device.uuid.slice(0, 7);
+			device.uuid = options.json ? device.uuid : device.uuid.slice(0, 7);
 
-			// @ts-ignore
-			device.device_type = device.is_of__device_type[0].slug;
+			device.device_type = device.is_of__device_type?.[0]?.slug || null;
 			return device;
 		});
 
@@ -113,24 +104,26 @@ export default class DevicesCmd extends Command {
 			'uuid',
 			'device_name',
 			'device_type',
-			'application_name',
+			'fleet',
 			'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 {
 			const _ = await import('lodash');
 			console.log(
-				JSON.stringify(
-					devices.map((device) => _.pick(device, fields)),
-					null,
-					4,
+				getVisuals().table.horizontal(
+					devices.map((dev) => _.mapValues(dev, (val) => val ?? 'N/a')),
+					fields,
 				),
 			);
-		} else {
-			console.log(getVisuals().table.horizontal(devices, fields));
 		}
 	}
 }

lib/commands/devices/supported.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright 2016-2019 Balena Ltd.
+ * 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.
@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 import { flags } from '@oclif/command';
-import type * as SDK from 'balena-sdk';
 import * as _ from 'lodash';
 import Command from '../../command';
 
@@ -24,10 +23,8 @@ import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
 import { CommandHelp } from '../../utils/oclif-utils';
 
 interface FlagsDef {
-	discontinued: boolean;
 	help: void;
 	json?: boolean;
-	verbose?: boolean;
 }
 
 export default class DevicesSupportedCmd extends Command {
@@ -36,11 +33,6 @@ export default class DevicesSupportedCmd extends Command {
 
 		List the supported device types (like 'raspberrypi3' or 'intel-nuc').
 
-		The --verbose option adds extra columns/fields to the output, including the
-		"STATE" column whose values are one of 'new', 'released' or 'discontinued'.
-		However, 'discontinued' device types are only listed if the '--discontinued'
-		option is used.
-
 		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
@@ -49,8 +41,7 @@ export default class DevicesSupportedCmd extends Command {
 `;
 	public static examples = [
 		'$ balena devices supported',
-		'$ balena devices supported --verbose',
-		'$ balena devices supported -vj',
+		'$ balena devices supported --json',
 	];
 
 	public static usage = (
@@ -59,55 +50,47 @@ export default class DevicesSupportedCmd extends Command {
 	).trim();
 
 	public static flags: flags.Input<FlagsDef> = {
-		discontinued: flags.boolean({
-			description: 'include "discontinued" device types',
-		}),
 		help: cf.help,
 		json: flags.boolean({
 			char: 'j',
 			description: 'produce JSON output instead of tabular output',
 		}),
-		verbose: flags.boolean({
-			char: 'v',
-			description:
-				'add extra columns in the tabular output (ALIASES, ARCH, STATE)',
-		}),
 	};
 
 	public async run() {
 		const { flags: options } = this.parse<FlagsDef, {}>(DevicesSupportedCmd);
-		const dts = await getBalenaSdk().models.config.getDeviceTypes();
-		let deviceTypes: Array<Partial<SDK.DeviceTypeJson.DeviceType>> = dts.map(
-			(d) => {
-				if (d.aliases && d.aliases.length) {
-					// remove aliases that are equal to the slug
-					d.aliases = d.aliases.filter((alias: string) => alias !== d.slug);
-					if (!options.json) {
-						// stringify the aliases array with commas and spaces
-						d.aliases = [d.aliases.join(', ')];
-					}
-				} else {
-					// ensure it is always an array (for the benefit of JSON output)
-					d.aliases = [];
-				}
-				return d;
-			},
-		);
-		if (!options.discontinued) {
-			deviceTypes = deviceTypes.filter((dt) => dt.state !== 'DISCONTINUED');
-		}
-		const fields = options.verbose
-			? ['slug', 'aliases', 'arch', 'state', 'name']
-			: ['slug', 'aliases', 'arch', 'name'];
-		deviceTypes = _.sortBy(
-			deviceTypes.map((d) => {
-				const picked = _.pick(d, fields);
-				// 'BETA' renamed to 'NEW'
-				picked.state = picked.state === 'BETA' ? 'NEW' : picked.state;
-				return picked;
+		const [dts, configDTs] = await Promise.all([
+			getBalenaSdk().models.deviceType.getAllSupported({
+				$expand: { is_of__cpu_architecture: { $select: 'slug' } },
+				$select: ['slug', 'name'],
 			}),
-			fields,
-		);
+			getBalenaSdk().models.config.getDeviceTypes(),
+		]);
+		const dtsBySlug = _.keyBy(dts, (dt) => dt.slug);
+		const configDTsBySlug = _.keyBy(configDTs, (dt) => dt.slug);
+		interface DT {
+			slug: string;
+			aliases: string[];
+			arch: string;
+			name: string;
+		}
+		let deviceTypes: DT[] = [];
+		for (const slug of Object.keys(dtsBySlug)) {
+			const configDT: Partial<typeof configDTs[0]> =
+				configDTsBySlug[slug] || {};
+			const aliases = (configDT.aliases || []).filter(
+				(alias) => alias !== slug,
+			);
+			const dt: Partial<typeof dts[0]> = dtsBySlug[slug] || {};
+			deviceTypes.push({
+				slug,
+				aliases: options.json ? aliases : [aliases.join(', ')],
+				arch: (dt.is_of__cpu_architecture as any)?.[0]?.slug || 'n/a',
+				name: dt.name || 'N/A',
+			});
+		}
+		const fields = ['slug', 'aliases', 'arch', 'name'];
+		deviceTypes = _.sortBy(deviceTypes, fields);
 		if (options.json) {
 			console.log(JSON.stringify(deviceTypes, null, 4));
 		} else {

lib/commands/env/add.ts

@@ -18,14 +18,13 @@
 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 { CommandHelp } from '../../utils/oclif-utils';
+import { applicationIdInfo } from '../../utils/messages';
 
 interface FlagsDef {
-	application?: string; // application name
+	fleet?: string;
 	device?: string; // device UUID
 	help: void;
 	quiet: boolean;
@@ -39,18 +38,17 @@ interface ArgsDef {
 
 export default class EnvAddCmd extends Command {
 	public static description = stripIndent`
-		Add env or config variable to application(s), device(s) or service(s).
+		Add env or config variable to fleets, devices or services.
 
-		Add an environment or config variable to one or more applications, devices
-		or services, as selected by the respective command-line options. Either the
-		--application or the --device option must be provided, and either may be be
+		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.
-		(A service is an application container in a "microservices" application.)
+		(A service corresponds to a Docker image/container in a microservices fleet.)
 		When the --service option is used in conjunction with the --device option,
-		the service variable applies to the selected device only. Otherwise, it
-		applies to all devices of the selected application (i.e., the application's
-		fleet). If the --service option is omitted, the variable applies to all
-		services.
+		the service variable applies to the selected device only.  Otherwise, it
+		applies to all devices of the selected fleet. If the --service option is
+		omitted, the variable applies to all services.
 
 		If VALUE is omitted, the CLI will attempt to use the value of the environment
 		variable of same name in the CLI process' environment. In this case, a warning
@@ -62,15 +60,18 @@ export default class EnvAddCmd extends Command {
 		running on devices. They are also stored differently in the balenaCloud API
 		database. Configuration variables cannot be set for specific services,
 		therefore the --service option cannot be used when the variable name starts
-		with a reserved prefix. When defining custom application variables, please
-		avoid the reserved prefixes.
-`;
+		with a reserved prefix. When defining custom fleet variables, please avoid
+		these reserved prefixes.
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+	`;
+
 	public static examples = [
-		'$ balena env add TERM --application MyApp',
-		'$ balena env add EDITOR vim --application MyApp',
-		'$ balena env add EDITOR vim --application MyApp,MyApp2',
-		'$ balena env add EDITOR vim --application MyApp --service MyService',
-		'$ balena env add EDITOR vim --application MyApp,MyApp2 --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',
@@ -91,13 +92,11 @@ export default class EnvAddCmd extends Command {
 		},
 	];
 
-	// hardcoded 'env add' to avoid oclif's 'env:add' topic syntax
-	public static usage =
-		'env add ' + new CommandHelp({ args: EnvAddCmd.args }).defaultUsage();
+	public static usage = 'env add <name> [value]';
 
 	public static flags: flags.Input<FlagsDef> = {
-		application: { exclusive: ['device'], ...cf.application },
-		device: { exclusive: ['application'], ...cf.device },
+		fleet: { ...cf.fleet, exclusive: ['device'] },
+		device: { ...cf.device, exclusive: ['fleet'] },
 		help: cf.help,
 		quiet: cf.quiet,
 		service: cf.service,
@@ -109,9 +108,9 @@ export default class EnvAddCmd extends Command {
 		);
 		const cmd = this;
 
-		if (!options.application && !options.device) {
+		if (!options.fleet && !options.device) {
 			throw new ExpectedError(
-				'Either the --application or the --device option must always be used',
+				'Either the --fleet or the --device option must be specified',
 			);
 		}
 
@@ -151,16 +150,17 @@ export default class EnvAddCmd extends Command {
 		}
 
 		const varType = isConfigVar ? 'configVar' : 'envVar';
-		if (options.application) {
-			for (const app of options.application.split(',')) {
+		if (options.fleet) {
+			const { getFleetSlug } = await import('../../utils/sdk');
+			for (const app of options.fleet.split(',')) {
 				try {
 					await balena.models.application[varType].set(
-						app,
+						await getFleetSlug(balena, app),
 						params.name,
 						params.value,
 					);
 				} catch (err) {
-					console.error(`${err.message}, app: ${app}`);
+					console.error(`${err.message}, fleet: ${app}`);
 					process.exitCode = 1;
 				}
 			}
@@ -182,15 +182,15 @@ export default class EnvAddCmd extends Command {
 }
 
 /**
- * Add service variables for a device or application.
+ * Add service variables for a device or fleet.
  */
 async function setServiceVars(
 	sdk: BalenaSdk.BalenaSDK,
 	params: ArgsDef,
 	options: FlagsDef,
 ) {
-	if (options.application) {
-		for (const app of options.application.split(',')) {
+	if (options.fleet) {
+		for (const app of options.fleet.split(',')) {
 			for (const service of options.service!.split(',')) {
 				try {
 					const serviceId = await getServiceIdForApp(sdk, app, service);
@@ -200,7 +200,7 @@ async function setServiceVars(
 						params.value!,
 					);
 				} catch (err) {
-					console.error(`${err.message}, application: ${app}`);
+					console.error(`${err.message}, fleet: ${app}`);
 					process.exitCode = 1;
 				}
 			}
@@ -215,7 +215,7 @@ async function setServiceVars(
 					sdk,
 					uuid,
 					['id'],
-					['app_name'],
+					['slug'],
 				);
 			} catch (err) {
 				console.error(`${err.message}, device: ${uuid}`);
@@ -224,11 +224,7 @@ async function setServiceVars(
 			}
 			for (const service of options.service!.split(',')) {
 				try {
-					const serviceId = await getServiceIdForApp(
-						sdk,
-						app.app_name,
-						service,
-					);
+					const serviceId = await getServiceIdForApp(sdk, app.slug, service);
 					await sdk.models.device.serviceVar.set(
 						device.id,
 						serviceId,
@@ -261,7 +257,7 @@ async function getServiceIdForApp(
 	}
 	if (serviceId === undefined) {
 		throw new ExpectedError(
-			`Cannot find service ${serviceName} for application ${appName}`,
+			`Cannot find service ${serviceName} for fleet ${appName}`,
 		);
 	}
 	return serviceId;

lib/commands/env/rename.ts

@@ -20,7 +20,6 @@ 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 { CommandHelp } from '../../utils/oclif-utils';
 import { parseAsInteger } from '../../utils/validation';
 
 type IArg<T> = import('@oclif/parser').args.IArg<T>;
@@ -39,9 +38,9 @@ interface ArgsDef {
 
 export default class EnvRenameCmd extends Command {
 	public static description = stripIndent`
-		Change the value of a config or env var for an app, device or service.
+		Change the value of a config or env var for a fleet, device or service.
 
-		Change the value of a configuration or environment variable for an application,
+		Change the value of a configuration or environment variable for a fleet,
 		device or service, as selected by command-line options.
 
 		${ec.rmRenameHelp.split('\n').join('\n\t\t')}
@@ -70,9 +69,7 @@ export default class EnvRenameCmd extends Command {
 		},
 	];
 
-	// hardcoded 'env rename' to avoid oclif's 'env:rename' topic syntax
-	public static usage =
-		'env rename ' + new CommandHelp({ args: EnvRenameCmd.args }).defaultUsage();
+	public static usage = 'env rename <id> <value>';
 
 	public static flags: flags.Input<FlagsDef> = {
 		config: ec.booleanConfig,

lib/commands/env/rm.ts

@@ -20,7 +20,6 @@ import Command from '../../command';
 
 import * as ec from '../../utils/env-common';
 import { getBalenaSdk, stripIndent } from '../../utils/lazy';
-import { CommandHelp } from '../../utils/oclif-utils';
 import { parseAsInteger } from '../../utils/validation';
 
 type IArg<T> = import('@oclif/parser').args.IArg<T>;
@@ -38,9 +37,9 @@ interface ArgsDef {
 
 export default class EnvRmCmd extends Command {
 	public static description = stripIndent`
-		Remove a config or env var from an application, device or service.
+		Remove a config or env var from a fleet, device or service.
 
-		Remove a configuration or environment variable from an application, device
+		Remove a configuration or environment variable from a fleet, device
 		or service, as selected by command-line options.
 
 		${ec.rmRenameHelp.split('\n').join('\n\t\t')}
@@ -67,9 +66,7 @@ export default class EnvRmCmd extends Command {
 		},
 	];
 
-	// hardcoded 'env rm' to avoid oclif's 'env:rm' topic syntax
-	public static usage =
-		'env rm ' + new CommandHelp({ args: EnvRmCmd.args }).defaultUsage();
+	public static usage = 'env rm <id>';
 
 	public static flags: flags.Input<FlagsDef> = {
 		config: ec.booleanConfig,
@@ -94,8 +91,6 @@ export default class EnvRmCmd extends Command {
 		await confirm(
 			opt.yes || false,
 			'Are you sure you want to delete the environment variable?',
-			undefined,
-			true,
 		);
 
 		const balena = getBalenaSdk();

lib/commands/envs.ts

@@ -0,0 +1,342 @@
+/**
+ * @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 * as SDK from 'balena-sdk';
+import * as _ from 'lodash';
+import Command from '../command';
+import { ExpectedError } from '../errors';
+import * as cf from '../utils/common-flags';
+import { getBalenaSdk, getVisuals, stripIndent } from '../utils/lazy';
+import { applicationIdInfo } from '../utils/messages';
+
+interface FlagsDef {
+	fleet?: string;
+	config: boolean;
+	device?: string; // device UUID
+	json: boolean;
+	help: void;
+	service?: string; // service name
+}
+
+interface EnvironmentVariableInfo extends SDK.EnvironmentVariableBase {
+	fleet?: string | null; // fleet slug
+	deviceUUID?: string; // device UUID
+	serviceName?: string; // service name
+}
+
+interface DeviceServiceEnvironmentVariableInfo
+	extends SDK.DeviceServiceEnvironmentVariable {
+	fleet?: string; // fleet slug
+	deviceUUID?: string; // device UUID
+	serviceName?: string; // service name
+}
+
+interface ServiceEnvironmentVariableInfo
+	extends SDK.ServiceEnvironmentVariable {
+	fleet?: string; // fleet slug
+	deviceUUID?: string; // device UUID
+	serviceName?: string; // service name
+}
+
+export default class EnvsCmd extends Command {
+	public static description = stripIndent`
+		List the environment or config variables of a fleet, device or service.
+
+		List the environment or configuration variables of a fleet, device or
+		service, as selected by the respective command-line options. (A service
+		corresponds to a Docker image/container in a microservices fleet.)
+
+		The results include fleet-wide (multiple devices), device-specific (multiple
+		services on a specific device) and service-specific variables that apply to the
+		selected fleet, device or service. It can be thought of as including inherited
+		variables; for example, a service inherits device-wide variables, and a device
+		inherits fleet-wide variables.
+
+		The printed output may include DEVICE and/or SERVICE columns to distinguish
+		between fleet-wide, device-specific and service-specific variables.
+		An asterisk in these columns indicates that the variable applies to
+		"all devices" or "all services".
+
+		The --config option is used to list "configuration variables" that control
+		balena platform features, as opposed to custom environment variables defined
+		by the user. The --config and the --service options are mutually exclusive
+		because configuration variables cannot be set for specific services.
+
+		The --json option is recommended when scripting the output of this command,
+		because the JSON format is less likely to change and it better represents data
+		types like lists and empty strings. The 'jq' utility may be helpful in shell
+		scripts (https://stedolan.github.io/jq/manual/). When --json is used, an empty
+		JSON array ([]) is printed instead of an error message when no variables exist
+		for the given query. When querying variables for a device, note that the fleet
+		name may be null in JSON output (or 'N/A' in tabular output) if the fleet that
+		the device belonged to is no longer accessible by the current user (for example,
+		in case the current user was removed from the fleet by the fleet's owner).
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+	`;
+
+	public static examples = [
+		'$ 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 usage = 'envs';
+
+	public static flags: flags.Input<FlagsDef> = {
+		fleet: { ...cf.fleet, exclusive: ['device'] },
+		config: flags.boolean({
+			default: false,
+			char: 'c',
+			description: 'show configuration variables only',
+			exclusive: ['service'],
+		}),
+		device: { ...cf.device, exclusive: ['fleet'] },
+		help: cf.help,
+		json: cf.json,
+		service: { ...cf.service, exclusive: ['config'] },
+	};
+
+	public async run() {
+		const { flags: options } = this.parse<FlagsDef, {}>(EnvsCmd);
+
+		const variables: EnvironmentVariableInfo[] = [];
+
+		await Command.checkLoggedIn();
+
+		if (!options.fleet && !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 fullUUID: string | undefined; // as oppposed to the short, 7-char UUID
+
+		if (options.device) {
+			const { getDeviceAndMaybeAppFromUUID } = await import('../utils/cloud');
+			const [device, app] = await getDeviceAndMaybeAppFromUUID(
+				balena,
+				options.device,
+				['uuid'],
+				['slug'],
+			);
+			fullUUID = device.uuid;
+			if (app) {
+				fleetSlug = app.slug;
+			}
+		}
+		if (fleetSlug && options.service) {
+			await validateServiceName(balena, options.service, fleetSlug);
+		}
+		variables.push(...(await getAppVars(balena, fleetSlug, options)));
+		if (fullUUID) {
+			variables.push(
+				...(await getDeviceVars(balena, fullUUID, fleetSlug, options)),
+			);
+		}
+		if (!options.json && variables.length === 0) {
+			const target =
+				(options.service ? `service "${options.service}" of ` : '') +
+				(options.fleet
+					? `fleet "${options.fleet}"`
+					: `device "${options.device}"`);
+			throw new ExpectedError(`No environment variables found for ${target}`);
+		}
+
+		await this.printVariables(variables, options);
+	}
+
+	protected async printVariables(
+		varArray: EnvironmentVariableInfo[],
+		options: FlagsDef,
+	) {
+		const fields = ['id', 'name', 'value', 'fleet'];
+
+		// Replace undefined app names with 'N/A' or null
+		varArray = varArray.map((i: EnvironmentVariableInfo) => {
+			i.fleet ||= options.json ? null : 'N/A';
+			return i;
+		});
+
+		if (options.device) {
+			fields.push(options.json ? 'deviceUUID' : 'deviceUUID => DEVICE');
+		}
+		if (!options.config) {
+			fields.push(options.json ? 'serviceName' : 'serviceName => SERVICE');
+		}
+
+		if (options.json) {
+			const { pickAndRename } = await import('../utils/helpers');
+			const mapped = varArray.map((o) => pickAndRename(o, fields));
+			this.log(JSON.stringify(mapped, null, 4));
+		} else {
+			this.log(
+				getVisuals().table.horizontal(
+					_.sortBy(varArray, (v: SDK.EnvironmentVariableBase) => v.name),
+					fields,
+				),
+			);
+		}
+	}
+}
+
+async function validateServiceName(
+	sdk: SDK.BalenaSDK,
+	serviceName: string,
+	fleetSlug: string,
+) {
+	const services = await sdk.models.service.getAllByApplication(fleetSlug, {
+		$filter: { service_name: serviceName },
+	});
+	if (services.length === 0) {
+		throw new ExpectedError(
+			`Service "${serviceName}" not found for fleet "${fleetSlug}"`,
+		);
+	}
+}
+
+/**
+ * Fetch application-wide config / env / service vars.
+ * If options.application is undefined, an attempt is made to obtain the
+ * application name from the device UUID (options.device). If this attempt
+ * fails because the device does not belong to any application, an emtpy
+ * array is returned.
+ */
+async function getAppVars(
+	sdk: SDK.BalenaSDK,
+	fleetSlug: string | undefined,
+	options: FlagsDef,
+): Promise<EnvironmentVariableInfo[]> {
+	const appVars: EnvironmentVariableInfo[] = [];
+	if (!fleetSlug) {
+		return appVars;
+	}
+	const vars = await sdk.models.application[
+		options.config ? 'configVar' : 'envVar'
+	].getAllByApplication(fleetSlug);
+	fillInInfoFields(vars, fleetSlug);
+	appVars.push(...vars);
+	if (!options.config) {
+		const pineOpts: SDK.PineOptions<SDK.ServiceEnvironmentVariable> = {
+			$expand: {
+				service: {},
+			},
+		};
+		if (options.service) {
+			pineOpts.$filter = {
+				service: {
+					service_name: options.service,
+				},
+			};
+		}
+		const serviceVars = await sdk.models.service.var.getAllByApplication(
+			fleetSlug,
+			pineOpts,
+		);
+		fillInInfoFields(serviceVars, fleetSlug);
+		appVars.push(...serviceVars);
+	}
+	return appVars;
+}
+
+/**
+ * Fetch config / env / service vars when the '--device' option is provided.
+ * Precondition: options.device must be defined.
+ */
+async function getDeviceVars(
+	sdk: SDK.BalenaSDK,
+	fullUUID: string,
+	fleetSlug: 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);
+		deviceVars.push(...deviceConfigVars);
+	} else {
+		const pineOpts: SDK.PineOptions<SDK.DeviceServiceEnvironmentVariable> = {
+			$expand: {
+				service_install: {
+					$expand: 'installs__service',
+				},
+			},
+		};
+		if (options.service) {
+			pineOpts.$filter = {
+				service_install: {
+					installs__service: { service_name: options.service },
+				},
+			};
+		}
+		const deviceServiceVars = await sdk.models.device.serviceVar.getAllByDevice(
+			fullUUID,
+			pineOpts,
+		);
+		fillInInfoFields(deviceServiceVars, fleetSlug, printedUUID);
+		deviceVars.push(...deviceServiceVars);
+
+		const deviceEnvVars = await sdk.models.device.envVar.getAllByDevice(
+			fullUUID,
+		);
+		fillInInfoFields(deviceEnvVars, fleetSlug, printedUUID);
+		deviceVars.push(...deviceEnvVars);
+	}
+	return deviceVars;
+}
+
+/**
+ * For each env var object in varArray, fill in its top-level serviceName
+ * and deviceUUID fields. An asterisk is used to indicate that the variable
+ * applies to "all services" or "all devices".
+ */
+function fillInInfoFields(
+	varArray:
+		| EnvironmentVariableInfo[]
+		| DeviceServiceEnvironmentVariableInfo[]
+		| ServiceEnvironmentVariableInfo[],
+	fleetSlug?: string,
+	deviceUUID?: string,
+) {
+	for (const envVar of varArray) {
+		if ('service' in envVar) {
+			// envVar is of type ServiceEnvironmentVariableInfo
+			envVar.serviceName = (envVar.service as SDK.Service[])[0]?.service_name;
+		} else if ('service_install' in envVar) {
+			// envVar is of type DeviceServiceEnvironmentVariableInfo
+			envVar.serviceName = (
+				(envVar.service_install as SDK.ServiceInstall[])[0]
+					?.installs__service as SDK.Service[]
+			)[0]?.service_name;
+		}
+		envVar.fleet = fleetSlug;
+		envVar.serviceName = envVar.serviceName || '*';
+		envVar.deviceUUID = deviceUUID || '*';
+	}
+}

lib/commands/fleet/create.ts

@@ -0,0 +1,149 @@
+/**
+ * @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 { 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';
+
+interface FlagsDef {
+	organization?: string;
+	type?: string; // application device type
+	help: void;
+}
+
+interface ArgsDef {
+	name: string;
+}
+
+export default 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() {
+		const { args: params, flags: options } = 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
+		console.log(
+			`Fleet created: slug "${application.slug}", device type "${deviceType}"`,
+		);
+	}
+
+	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);
+		}
+	}
+}

lib/commands/fleet/index.ts

@@ -0,0 +1,103 @@
+/**
+ * @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 { 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 } from '../../utils/messages';
+import { isV14 } from '../../utils/version';
+import type { DataOutputOptions } from '../../framework';
+
+interface FlagsDef extends DataOutputOptions {
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+}
+
+export default 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,
+		...(isV14() ? cf.dataOutputFlags : {}),
+	};
+
+	public static authenticated = true;
+	public static primary = true;
+
+	public async run() {
+		const { args: params, flags: options } = 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;
+
+		if (isV14()) {
+			await this.outputData(
+				application,
+				['app_name', 'id', 'device_type', 'slug', 'commit'],
+				options,
+			);
+		} else {
+			// Emulate table.vertical title output, but avoid uppercasing and inserting spaces
+			console.log(`== ${application.slug}`);
+			console.log(
+				getVisuals().table.vertical(application, [
+					'id',
+					'device_type',
+					'slug',
+					'commit',
+				]),
+			);
+		}
+	}
+}

lib/commands/fleet/purge.ts

@@ -0,0 +1,81 @@
+/**
+ * @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 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 {
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+}
+
+export default class FleetPurgeCmd extends Command {
+	public static description = stripIndent`
+		Purge data from a fleet.
+
+		Purge data from all devices belonging to a fleet.
+		This will clear the fleet's '/data' directory.
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+	`;
+
+	public static examples = [
+		'$ balena fleet purge MyFleet',
+		'$ balena fleet purge myorg/myfleet',
+	];
+
+	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 } = this.parse<FlagsDef, ArgsDef>(FleetPurgeCmd);
+
+		const { getApplication } = await import('../../utils/sdk');
+
+		const balena = getBalenaSdk();
+
+		// 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);
+
+		try {
+			await balena.models.application.purge(application.id);
+		} catch (e) {
+			if (e.message.toLowerCase().includes('no online device(s) found')) {
+				// application.purge throws an error if no devices are online
+				// ignore in this case.
+			} else {
+				throw e;
+			}
+		}
+	}
+}

lib/commands/fleet/rename.ts

@@ -0,0 +1,149 @@
+/**
+ * @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 { 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';
+
+interface FlagsDef {
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+	newName?: string;
+}
+
+export default class FleetRenameCmd extends Command {
+	public static description = stripIndent`
+		Rename a fleet.
+
+		Rename a fleet.
+
+		Note, if the \`newName\` parameter is omitted, it will be
+		prompted for interactively.
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+	`;
+
+	public static examples = [
+		'$ balena fleet rename OldName',
+		'$ balena fleet rename OldName NewName',
+		'$ balena fleet rename myorg/oldname NewName',
+	];
+
+	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 } = this.parse<FlagsDef, ArgsDef>(FleetRenameCmd);
+
+		const { validateApplicationName } = await import('../../utils/validation');
+		const { ExpectedError } = await import('../../errors');
+
+		const balena = getBalenaSdk();
+
+		// 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, {
+			$expand: {
+				application_type: {
+					$select: ['is_legacy'],
+				},
+			},
+		});
+
+		// Check app exists
+		if (!application) {
+			throw new ExpectedError(`Error: fleet ${params.fleet} not found.`);
+		}
+
+		// Check app supports renaming
+		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.`,
+			);
+		}
+
+		// Ascertain new name
+		const newName =
+			params.newName ||
+			(await getCliForm().ask({
+				message: 'Please enter the new name for this fleet:',
+				type: 'input',
+				validate: validateApplicationName,
+			})) ||
+			'';
+
+		// 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 e;
+		}
+
+		// Get application again, to be sure of results
+		const renamedApplication = await balena.models.application.get(
+			application.id,
+		);
+
+		// Output result
+		console.log(`Fleet renamed`);
+		console.log('From:');
+		console.log(`\tname: ${application.app_name}`);
+		console.log(`\tslug: ${application.slug}`);
+		console.log('To:');
+		console.log(`\tname: ${renamedApplication.app_name}`);
+		console.log(`\tslug: ${renamedApplication.slug}`);
+	}
+}

lib/commands/fleet/restart.ts

@@ -0,0 +1,70 @@
+/**
+ * @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 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 {
+	help: void;
+}
+
+interface ArgsDef {
+	fleet: string;
+}
+
+export default 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() {
+		const { args: params } = 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);
+	}
+}

lib/commands/fleet/rm.ts

@@ -15,11 +15,13 @@
  * limitations under the License.
  */
 
-import { flags } from '@oclif/command';
+import type { flags } from '@oclif/command';
+
 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 { tryAsInteger } from '../../utils/validation';
+import { applicationIdInfo } from '../../utils/messages';
 
 interface FlagsDef {
 	yes: boolean;
@@ -27,31 +29,29 @@ interface FlagsDef {
 }
 
 interface ArgsDef {
-	name: string;
+	fleet: string;
 }
 
-export default class AppRmCmd extends Command {
+export default class FleetRmCmd extends Command {
 	public static description = stripIndent`
-		Remove an application.
+		Remove a fleet.
 
-		Permanently remove a balena application.
+		Permanently remove a fleet.
 
 		The --yes option may be used to avoid interactive confirmation.
-`;
+
+		${applicationIdInfo.split('\n').join('\n\t\t')}
+	`;
+
 	public static examples = [
-		'$ balena app rm MyApp',
-		'$ balena app rm MyApp --yes',
+		'$ balena fleet rm MyFleet',
+		'$ balena fleet rm MyFleet --yes',
+		'$ balena fleet rm myorg/myfleet',
 	];
 
-	public static args = [
-		{
-			name: 'name',
-			description: 'application name or numeric ID',
-			required: true,
-		},
-	];
+	public static args = [ca.fleetRequired];
 
-	public static usage = 'app rm <name>';
+	public static usage = 'fleet rm <fleet>';
 
 	public static flags: flags.Input<FlagsDef> = {
 		yes: cf.yes,
@@ -62,18 +62,23 @@ export default class AppRmCmd extends Command {
 
 	public async run() {
 		const { args: params, flags: options } = this.parse<FlagsDef, ArgsDef>(
-			AppRmCmd,
+			FleetRmCmd,
 		);
 
-		const patterns = await import('../../utils/patterns');
+		const { confirm } = await import('../../utils/patterns');
+		const { getApplication } = await import('../../utils/sdk');
+		const balena = getBalenaSdk();
 
 		// Confirm
-		await patterns.confirm(
+		await confirm(
 			options.yes ?? false,
-			`Are you sure you want to delete application ${params.name}?`,
+			`Are you sure you want to delete fleet ${params.fleet}?`,
 		);
 
+		// Disambiguate application (if is a number, it could either be an ID or a numerical name)
+		const application = await getApplication(balena, params.fleet);
+
 		// Remove
-		await getBalenaSdk().models.application.remove(tryAsInteger(params.name));
+		await balena.models.application.remove(application.id);
 	}
 }

lib/commands/fleets.ts

@@ -0,0 +1,108 @@
+/**
+ * @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 Command from '../command';
+import * as cf from '../utils/common-flags';
+import { getBalenaSdk, getVisuals, stripIndent } from '../utils/lazy';
+import { isV14 } from '../utils/version';
+import type { DataSetOutputOptions } from '../framework';
+
+interface ExtendedApplication extends ApplicationWithDeviceType {
+	device_count: number;
+	online_devices: number;
+	device_type?: string;
+}
+
+interface FlagsDef extends DataSetOutputOptions {
+	help: void;
+	verbose?: boolean;
+}
+
+export default 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> = {
+		...(isV14() ? cf.dataSetOutputFlags : {}),
+		help: cf.help,
+	};
+
+	public static authenticated = true;
+	public static primary = true;
+
+	public async run() {
+		const { flags: options } = this.parse<FlagsDef, {}>(FleetsCmd);
+
+		const balena = getBalenaSdk();
+
+		// Get applications
+		const applications =
+			(await balena.models.application.getAllDirectlyAccessible({
+				$select: ['id', 'app_name', 'slug'],
+				$expand: {
+					is_for__device_type: { $select: 'slug' },
+					owns__device: { $select: 'is_online' },
+				},
+			})) as ExtendedApplication[];
+
+		// Add extended properties
+		applications.forEach((application) => {
+			application.device_count = application.owns__device?.length ?? 0;
+			application.online_devices =
+				application.owns__device?.filter((d) => d.is_online).length || 0;
+			application.device_type = application.is_for__device_type[0].slug;
+		});
+
+		if (isV14()) {
+			await this.outputData(
+				applications,
+				[
+					'id',
+					'app_name',
+					'slug',
+					'device_type',
+					'device_count',
+					'online_devices',
+				],
+				options,
+			);
+		} else {
+			console.log(
+				getVisuals().table.horizontal(applications, [
+					'id',
+					'app_name => NAME',
+					'slug',
+					'device_type',
+					'online_devices',
+					'device_count',
+				]),
+			);
+		}
+	}
+}