Fix Windows installer build in new balena CI workers (qqjs patch)

Change-type: patch

.editorconfig

@@ -9,4 +9,8 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.md]
-trim_trailing_whitespace = false
+trim_trailing_whitespace = false
+
+[package.json]
+indent_style = space
+indent_size = 2

.gitattributes

@@ -0,0 +1,12 @@
+# Set all files to use line feed endings (since we can't match only ones without an extension)
+* eol=lf
+# And then reset all the files with extensions back to default
+*.* -eol
+
+*.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
+# 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

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

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,76 @@
+
+# About this issue tracker
+
+*The balena CLI (Command Line Interface) is a tool used to interact with the balena platform.
+This GitHub issue tracker is used for bug reports and feature requests regarding the CLI
+tool. General and troubleshooting questions (such as setting up your project to work with a
+balenalib base image) are encouraged to be posted to the [balena
+forums](https://forums.balena.io), which are monitored by balena's support team and where the
+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!*
+
+---
+
+# Expected Behavior
+
+Please describe what you were expecting to happen. If applicable, please add links to
+documentation you were following, or to projects that you were trying to push/build.
+
+# Actual Behavior
+
+Please describe what actually happened instead:
+* Quoting logs and error message is useful. If possible, quote the **full** output of the
+  CLI, not just the error message.
+* Please quote the **full command line** too. Sometimes users report that they were
+  "pushing" or "building" a project, but there are several ways to do so and several
+  possible "targets" such as balenaCloud, openBalena, local balenaOS device, etc.
+  Examples:
+
+```
+balena push myApp
+balena push 192.168.0.12
+balena deploy myApp
+balena deploy myApp --build
+balena build . -a myApp
+balena build . -A armv7hf -d raspberrypi3
+```
+
+Each of the above command lines executes different code behind the scenes, so quoting the
+full command line is very helpful.
+
+Running the CLI in debug mode (`--debug` flag or `DEBUG=1` environment variable) may reveal
+additional information. The `--logs` option reveals additional information for the commands:
+
+```
+balena build . --logs
+balena deploy myApp --build --logs
+```
+
+# Steps to Reproduce the Problem
+
+This is the most important and helpful part of a bug report. If we cannot reproduce the
+problem, it is difficult to tell what the fix should be, or whether code changes have
+fixed it.
+
+1.
+1.
+1.
+
+# Specifications
+
+- **balena CLI version:** e.g. 1.2.3 (output of the `"balena version -a"` command)
+- **Cloud backend: openBalena or balenaCloud?** If unsure, it will be balenaCloud
+- **Operating system version:** e.g. Windows 10, Ubuntu 18.04, macOS 10.14.5
+- **32/64 bit OS and processor:** e.g. 32-bit Windows on 64-bit Intel processor
+- **Install method:** npm or zip package or executable installer
+- **If npm install, Node.js and npm version:** e.g. Node v8.16.0 and npm v6.4.1
+
+# Additional References
+
+If applicable, please add additional links to GitHub projects, forums.balena.io threads,
+gist.github.com, Google Drive attachments, etc.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,26 @@
+<!-- You can remove tags that do not apply. -->
+Resolves: # <!-- Refer an issue of this repository that this PR fixes -->  
+Change-type: major|minor|patch <!-- See https://semver.org/ -->  
+Depends-on: <url> <!-- This change depends on a PR to get merged/deployed first -->  
+See: <url> <!-- Refer to any external resource, like a PR, document or discussion -->  
+
+---
+Please check the CONTRIBUTING.md file for relevant information and some
+guidance. Keep in mind that the CLI is a cross-platform application that runs
+on Windows, macOS and Linux. Tests will be automatically run by balena CI on
+all three operating systems, but this will only help if you have added test
+code that exercises the modified or added feature code.
+
+Note that each commit message (currently only the first line) will be
+automatically copied to the CHANGELOG.md file, so try writing it in a way
+that describes the feature or fix for CLI users.
+
+If there isn't a linked issue or if the linked issue doesn't quite match the
+PR, please add a PR description to explain its purpose or the features that it
+implements. Adding PR comments to blocks of code that aren't self explanatory
+usually helps with the review process.
+
+If the PR introduces security considerations or affects the development, build
+or release process, please be sure to highlight this in the PR description.
+
+Thank you very much for your contribution!

.gitignore

@@ -12,9 +12,7 @@ lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
+.nyc_output
 
 # node-waf configuration
 .lock-wscript
@@ -27,10 +25,23 @@ build/Release
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
 node_modules
 
-bin/node
-
-release/build
-
-npm-shrinkwrap.json
+package-lock.json
 .resinconf
+.balenaconf
 resinrc.yml
+balenarc.yml
+
+.DS_Store
+.idea
+.nvmrc
+.vscode
+
+/tmp
+build/
+build-bin/
+build-zip/
+dist/
+
+# Ignore fast-boot cache file
+**/.fast-boot.json
+/oclif.manifest.json

.hound.yml

@@ -1,5 +1,2 @@
-coffee_script:
-  config_file: coffeelint.json
-
 javascript:
   enabled: false

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

.npmignore

@@ -1,4 +0,0 @@
-tests
-doc
-lib
-extras

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all",
+  "useTabs": true
+}

.resinci.yml

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

.travis.yml

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,239 @@
+# Contributing
+
+The balena CLI is an open source project and your contribution is welcome!
+
+* 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`).
+
+In order to ease development:
+
+* `npm run build:fast` skips some of the build steps for interactive testing, or
+* `npm run test:source` skips testing the standalone zip packages (which is rather slow)
+* `./bin/balena-dev` uses `ts-node/register` to transpile on the fly.
+
+Before opening a PR, test your changes with `npm test`. Keep compatibility in mind, as the CLI is
+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!
+
+## Semantic versioning, commit messages and the ChangeLog
+
+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.
+
+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 support this automation, a commit message should be structured as follows:
+
+```text
+The first line becomes a bullet point in the CHANGELOG file
+
+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.
+
+Change-type: patch|minor|major
+```
+
+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.
+
+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.
+
+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 `doc/cli.markdown` file is automatically generated by running `npm run build:doc` (which also
+runs as part of `npm run build`). That file is then pulled by scripts in the
+[balena-io/docs](https://github.com/balena-io/docs/) GitHub repo for publishing at the [CLI
+Documentation page](https://www.balena.io/docs/reference/cli/).
+
+The content sources for the auto generation of `doc/cli.markdown` are:
+
+* [Selected
+  sections](https://github.com/balena-io/balena-cli/blob/v12.23.0/automation/capitanodoc/capitanodoc.ts#L199-L204)
+  of the README file.
+* The CLI's command documentation in source code (`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
+[`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.
+
+## Windows
+
+The `npm run build:installer` script (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 changes are made to npm scripts in `package.json`,
+check that they also run on a standard Windows Command Prompt.
+
+## 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.
+
+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:
+
+```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
+```
+
+## TypeScript and oclif
+
+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.
+
+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
+
+`npm run build` also runs [balena-lint](https://www.npmjs.com/package/@balena/lint), which automatically
+reformats the code. Beyond that, we have a preference for Javascript promises over callbacks, and for
+`async/await` over `.then()`.
+
+## Common gotchas
+
+One thing that most CLI bugs have in common is the absence of test cases exercising the broken
+code, so writing some test code is a great idea. Having said that, there are also some common
+gotchas to bear in mind:
+
+* Forward slashes ('/') _vs._ backslashes ('\') in file paths. The Node.js
+  [path.sep](https://nodejs.org/docs/latest-v12.x/api/path.html#path_path_sep) variable stores a
+  platform-specific path separator character: the backslash on Windows and the forward slash on
+  Linux and macOS. The
+  [path.join](https://nodejs.org/docs/latest-v12.x/api/path.html#path_path_join_paths) function
+  builds paths using such platform-specific path separator. However:
+  * Note that Windows (kernel, cmd.exe, PowerShell, many applications) accepts ***both*** forward
+    slashes and backslashes as path separators (including mixing them in a path string), so code
+    like `mypath.split(path.sep)` may fail on Windows if `mypath` contains forward slashes. The
+    [path.parse](https://nodejs.org/docs/latest-v12.x/api/path.html#path_path_parse_path) function
+    understands both forward slashes and backslashes on Windows, and the
+    [path.normalize](https://nodejs.org/docs/latest-v12.x/api/path.html#path_path_normalize_path)
+    function will _replace_ forward slashes with backslashes.
+  * In [tar](https://en.wikipedia.org/wiki/Tar_(computing)#File_format) streams sent to the Docker
+    daemon and to balenaCloud, the forward slash is the only acceptable path separator, regardless
+    of the OS where the CLI is running. Therefore, `path.sep` and `path.join` should never be used
+    when handling paths in tar streams! `path.posix.join` may be used instead of `path.join`.
+
+* Avoid using the system shell to execute external commands, for example:  
+  `child_process.exec('ssh "arg1" "arg2"');`  
+  `child_process.spawn('ssh "arg1" "arg2"', { shell: true });`  
+  Besides the usual security concerns of unsanitized strings, another problem is to get argument
+  escaping right because of the differences between the Windows 'cmd.exe' shell and the Unix
+  '/bin/sh'. For example, 'cmd.exe' doesn't recognize single quotes like '/bin/sh', and uses the
+  caret (^) instead of the backslash as the escape character. Bug territory! Most of the time,
+  it is possible to avoid relying on the shell altogether by providing a Javascript array of
+  arguments:  
+  `spawn('ssh', ['arg1', 'arg2'], { shell: false});`  
+  To allow for logging and debugging, the [which](https://www.npmjs.com/package/which) package may
+  be used to get the full path of a command before executing it, without relying on any shell:  
+  `const fullPath = await which('ssh');`  
+  `console.log(fullPath);  # 'C:\WINDOWS\System32\OpenSSH\ssh.EXE'`  
+  `spawn(fullPath, ['arg1', 'arg2'], { shell: false });`
+
+* Avoid the `instanceof` operator when testing against classes/types from external packages
+  (including base classes), because `npm install` may result in multiple versions of the same
+  package being installed (to satisfy declared dependencies) and a false negative may result when
+  comparing an object instance from one package version with a class of another package version
+  (even if the implementations are identical in both packages). For example, once we fixed a bug
+  where the test:  
+  `error instanceof BalenaApplicationNotFound`  
+  changed from true to false because `npm install` added an additional copy of the `balena-errors`
+  package to satisfy a minor `balena-sdk` version update:  
+  `$ find node_modules -name balena-errors`  
+  `node_modules/balena-errors`  
+  `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'`

INSTALL-ADVANCED.md

@@ -0,0 +1,150 @@
+# 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/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.
+>   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 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`, `scan`, `build`, `deploy`, `preload` and `os configure` 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)
+
+The `build` and `deploy` commands are also capable of using Docker or balenaEngine 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. For more details,
+check `balena help build` or the [online
+reference](https://www.balena.io/docs/reference/cli/#cli-command-reference).

INSTALL-LINUX.md

@@ -0,0 +1,66 @@
+# balena CLI Installation Instructions for Linux
+
+These instructions are for the recommended installation option. They are suitable for most Linux
+distributions, except notably for **Linux Alpine** or **Busybox**. For these distros, see [advanced
+installation options](./INSTALL-ADVANCED.md).
+
+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. The extracted contents will include a
+   `balena-cli` folder.
+
+3. Add the `balena-cli` folder to the system's `PATH` environment variable. There are several
+   ways of achieving this on Linux: See this [StackOverflow post](https://stackoverflow.com/questions/14637979/how-to-permanently-set-path-on-linux-unix). 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
+   command terminal:  
+   * `balena version` - should print the CLI's version
+   * `balena help` - should print a list of available commands
+
+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.
+
+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.
+
+## 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 simply follow [Docker's installation
+instructions](https://docs.docker.com/install/overview/) to install Docker on the same laptop (dev
+machine) where the balena CLI is installed. The [advanced installation
+options](./INSTALL-ADVANCED.md) 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,68 @@
+# 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 the downloaded file to run the installer. 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).
+
+3. Check that the installation was successful by running the following commands on a
+   command terminal:  
+   * `balena version` - should print the CLI's version
+   * `balena help` - should print a list of available commands
+
+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 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 simply follow [Docker's installation
+instructions](https://docs.docker.com/install/overview/) to install Docker on the same laptop (dev
+machine) where the balena CLI is installed. The [advanced installation
+options](./INSTALL-ADVANCED.md) 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, with the additional
+restriction that Docker must be installed on the local machine (because Docker's bind mounting
+feature is used). Also, for some device types (such as the Raspberry Pi), the `preload` command
+requires Docker to support the [AUFS storage
+driver](https://docs.docker.com/storage/storagedriver/aufs-driver/). Unfortunately, Docker Desktop
+for Windows dropped support for the AUFS filesystem in Docker CE versions greater than 18.06.1. The
+present workaround is to either:
+
+* 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)
+* Install the balena CLI on a Linux machine (as Docker for Linux still supports AUFS). A Linux
+  Virtual Machine also works, but a Docker container is _not_ recommended.
+
+Long term, we are working on replacing AUFS with overlay2 for the affected device types.

INSTALL-WINDOWS.md

@@ -0,0 +1,82 @@
+# 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 the downloaded file to run the installer. 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).
+
+3. Check that the installation was successful by running the following commands on a
+   command terminal:  
+   * `balena version` - should print the CLI's version
+   * `balena help` - should print a list of available commands
+
+No further steps are required to run most CLI commands. The `balena ssh`, `scan`, `build`,
+`deploy`, `preload` and `os configure` 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 simply follow [Docker's installation
+instructions](https://docs.docker.com/install/overview/) to install Docker on the same laptop (dev
+machine) where the balena CLI is installed. The [advanced installation
+options](./INSTALL-ADVANCED.md) 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, with the additional
+restriction that Docker must be installed on the local machine (because Docker's bind mounting
+feature is used). Also, for some device types (such as the Raspberry Pi), the `preload` command
+requires Docker to support the [AUFS storage
+driver](https://docs.docker.com/storage/storagedriver/aufs-driver/). Unfortunately, Docker Desktop
+for Windows dropped support for the AUFS filesystem in Docker CE versions greater than 18.06.1. The
+present workaround is to either:
+
+* 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)
+* Install the balena CLI on a Linux machine (as Docker for Linux still supports AUFS). A Linux
+  Virtual Machine also works, but a Docker container is _not_ recommended.
+
+Long term, we are working on replacing AUFS with overlay2 for the affected device types.
+
+### balena os configure
+
+* The `balena os configure` command is currently not supported on Windows natively, but works with
+  the [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/about) (WSL). When
+  using WSL, [install the balena CLI for
+  Linux](https://github.com/balena-io/balena-cli/blob/master/INSTALL-LINUX.md).

INSTALL.md

@@ -0,0 +1,12 @@
+# balena CLI Installation Instructions
+
+Please select your operating system:
+
+* [Windows](./INSTALL-WINDOWS.md)
+* [macOS](./INSTALL-MAC.md)
+* [Linux](./INSTALL-LINUX.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
+> rather than Windows, as WSL consists of a Linux environment.

README.md

@@ -1,77 +1,176 @@
-Resin CLI
-=========
+# balena CLI
 
-> The official Resin CLI tool.
+The official balena Command Line Interface.
 
-[![npm version](https://badge.fury.io/js/resin-cli.svg)](http://badge.fury.io/js/resin-cli)
-[![dependencies](https://david-dm.org/resin-io/resin-cli.svg)](https://david-dm.org/resin-io/resin-cli)
-[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/resin-io/chat)
+[![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)
 
-Requisites
-----------
+## About
 
-- [NodeJS](https://nodejs.org) (at least v0.10)
-- [Git](https://git-scm.com)
+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!
 
-Getting Started
----------------
+## Installation
 
-### Installing
+Check the [balena CLI installation instructions on
+GitHub](https://github.com/balena-io/balena-cli/blob/master/INSTALL.md).
 
-This might require elevated privileges in some environments.
+## 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. Alternative shells include:
+
+* [MSYS2](https://www.msys2.org/):
+  * Install additional packages with the command:  
+    `pacman -S git openssh rsync`
+  * [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
+* [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** 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
+auto completion may be enabled by copying the
+[balena-completion.bash](https://github.com/balena-io/balena-cli/blob/master/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
+
+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:
 
 ```sh
-$ npm install --global --production resin-cli
+$ balena login
 ```
 
-### List available commands
+## Proxy support
 
-```sh
-$ resin help
+HTTP(S) proxies can be configured through any of the following methods, in precedence order
+(from higher to lower):
+
+* The `BALENARC_PROXY` environment variable in URL format, with protocol (`http` or `https`),
+  host, port and optionally basic auth. Examples:
+  * `export BALENARC_PROXY='https://bob:secret@proxy.company.com:12345'`
+  * `export BALENARC_PROXY='http://localhost:8000'`
+
+* The `proxy` setting in the [CLI config
+  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'
+        host: 'proxy.company.com'
+        port: 12345
+        proxyAuth: 'bob:secret'
+    ```
+
+* The `HTTPS_PROXY` and/or `HTTP_PROXY` environment variables, in the same URL format as
+  `BALENARC_PROXY`.
+
+### Proxy setup for balena ssh
+
+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 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
+>   `--noproxy` option should be specified in addition to the `BALENARC_NO_PROXY` variable.
+
+By default (if `BALENARC_NO_PROXY` is not defined), all [private IPv4
+addresses](https://en.wikipedia.org/wiki/Private_network) and `'*.local'` hostnames are excluded
+from proxying. Other hostnames that resolve to private IPv4 addresses are **not** excluded by
+default, because matching takes place before name resolution.
+
+`localhost` and `127.0.0.1` are always excluded from proxying, regardless of the value of
+BALENARC_NO_PROXY.
+
+The format of the `BALENARC_NO_PROXY` environment variable is a comma-separated list of patterns
+that are matched against hostnames or IP addresses. For example:
+
+```
+export BALENARC_NO_PROXY='*.local,dev*.mycompany.com,192.168.*'
 ```
 
-### Run the quickstart wizard
+Matched patterns are excluded from proxying. Wildcard expressions are documented at
+[matcher](https://www.npmjs.com/package/matcher#usage). Matching takes place _before_ name
+resolution, so a pattern like `'192.168.*'` will **not** match a hostname that resolves to an IP
+address like `192.168.1.2`.
 
-```sh
-$ resin quickstart
-```
+## Command reference documentation
 
-Plugins
--------
+The full CLI command reference is available [on the web](https://www.balena.io/docs/reference/cli/
+) or by running `balena help --verbose`.
 
-The Resin CLI can be extended with plugins to automate laborious tasks and overall provide a better experience when working with Resin.io. Check the [plugin development tutorial](https://github.com/resin-io/resin-plugin-hello) to learn how to build your own!
+## Support, FAQ and troubleshooting
 
-FAQ
----
+To learn more, troubleshoot issues, or to contact us for support:
 
-### Where is my configuration file?
+* 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 through the [balenaCloud forum](https://forums.balena.io/c/balena-cloud)
 
-The per-user configuration file lives in `$HOME/.resinrc.yml` or `%UserProfile%\_resinrc.yml`, in Unix based operating systems and Windows respectively.
+For CLI bug reports or feature requests, check the
+[CLI GitHub issues](https://github.com/balena-io/balena-cli/issues/).
 
-The Resin CLI also attempts to read a `resinrc.yml` file in the current directory, which takes precedence over the per-user configuration file.
+## Deprecation policy
 
-### How do I point the Resin CLI to staging?
+The balena CLI uses [semver versioning](https://semver.org/), with the concepts
+of major, minor and patch version releases.
 
-The easiest way is to set the `RESINRC_RESIN_URL=resinstaging.io` environment variable.
+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 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.
 
-Alternatively, you can edit your configuration file and set `resinUrl: resinstaging.io` to persist this setting.
+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.
 
-### How do I make the Resin CLI persist data in another directory?
+## Contributing (including editing documentation files)
 
-The Resin CLI persists your session token, as well as cached images in `$HOME/.resin` or `%UserProfile%\_resin`.
+Please have a look at the [CONTRIBUTING.md](./CONTRIBUTING.md) file for some guidance before
+submitting a pull request or updating documentation (because some files are automatically
+generated). Thank you for your help and interest!
 
-Pointing the Resin 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 Resin OS, which erases all data after a restart.
+## License
 
-You can accomplish this by setting `RESINRC_DATA_DIRECTORY=/opt/resin` or adding `dataDirectory: /opt/resin` to your configuration file, replacing `/opt/resin` with your desired directory.
-
-Support
--------
-
-If you're having any problem, check our [troubleshooting guide](https://github.com/resin-io/resin-cli/blob/master/TROUBLESHOOTING.md) and if your problem is not addressed there, please [raise an issue](https://github.com/resin-io/resin-cli/issues/new) on GitHub and the Resin.io team will be happy to help.
-
-You can also get in touch with us at our public [Gitter chat channel](https://gitter.im/resin-io/chat).
-
-License
--------
-
-The project is licensed under the Apache 2.0 license.
+The project is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
+A copy is also available in the LICENSE file in this repository.

TROUBLESHOOTING.md

@@ -1,59 +1,126 @@
-Troubleshooting
-===============
+# balena CLI FAQ & Troubleshooting
 
-This document contains common issues related to the Resin CLI, and how to fix them.
+## Where is the balena CLI's configuration file located?
 
-### After burning to an sdcard, my device doesn't boot
+The per-user configuration file lives in `$HOME/.balenarc.yml` or `%UserProfile%\_balenarc.yml`, in
+Unix based operating systems and Windows respectively.
 
-- The downloaded image is not complete (download was interrupted).
+The balena CLI also attempts to read a `balenarc.yml` file in the current directory, which takes
+precedence over the per-user configuration file.
 
-Please clean the cache (`%HOME/.resin/cache` or `C:\Users\<user>\_resin\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.
+## How do I point the balena CLI to the staging environment?
 
-### I get a permission error when burning to an sdcard
+Set the `BALENARC_BALENA_URL=balena-staging.com` environment variable, or add
+`balenaUrl: balena-staging.com` to the balena CLI's configuration file.
 
-- The SDCard is locked.
+## How do I make the balena CLI persist data in another directory?
 
-### I get EINVAL errors on Cygwin
+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.
 
-The errors look something like this:
+## After burning to an SD card, my device doesn't boot
+
+Check whether the downloaded image is incomplete (download was interrupted) or corrupted.
+
+Try clearing the cache (`%HOME/.balena/cache` or `C:\Users\<user>\_balena\cache`) and running the
+command again.
+
+## I get a permission error when burning to an SD card
+
+Check whether the SD card is locked (a physical switch on the side of the card).
+
+## I get EINVAL errors on Cygwin
+
+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\resin-cli\node_modules\inquirer\node_modules\readline2\index.js:31:43)
-  at PromptUI.UI (C:\cygwin\home\Juan Cruz Viotti\Projects\resin-cli\node_modules\inquirer\lib\ui\baseUI.js:23:40)
-  at new PromptUI (C:\cygwin\home\Juan Cruz Viotti\Projects\resin-cli\node_modules\inquirer\lib\ui\prompt.js:26:8)
-  at Object.promptModule [as prompt] (C:\cygwin\home\Juan Cruz Viotti\Projects\resin-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
+## I get `Invalid MBR boot signature` when configuring a device
 
 This error, accompanied with something like: `Expected 0xAA55, but saw 0x29FE` usually indicates a corrupted device operating system image in the cache, due to bad a internet connection during the download process.
 
 Try clearing the cache with the following command and trying again:
 
 ```sh
-$ rm -rf $HOME/.resin/cache
+$ rm -rf $HOME/.balena/cache
 ```
 
 Or in Windows:
 
 ```sh
-> del /s /q %UserProfile%\_resin\cache
+> del /s /q %UserProfile%\_balena\cache
 ```
 
-### I get `EACCES: permission denied` when logging in
+## I get `EACCES: permission denied` when logging in
 
-The Resin CLI stores the session token in `$HOME/.resin` or `C:\Users\<user>\_resin` 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 Resin 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:
 
 ```sh
-$ sudo chown -R <user> $HOME/.resin
+$ 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 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
+stty sane
+shopt -s checkwinsize
+bind 'set horizontal-scroll-mode off'
+```
+
+Terminal multiplexer tools like GNU `screen` or `tmux` are sometimes reported to fix the issues, though at other times they are reported as the _cause_ of the problem. They have their own configuration files to take into account.
+
+Further reference:
+* https://stackoverflow.com/questions/1133031/shell-prompt-line-wrapping-issue
+* https://superuser.com/questions/46948/any-way-to-fix-screens-mishandling-of-line-wrap-maybe-only-terminal-app
+* https://unix.stackexchange.com/questions/105958/terminal-prompt-not-wrapping-correctly
+* https://unix.stackexchange.com/questions/529377/terminal-long-line-wrapping
+* https://github.com/microsoft/WSL/issues/1436
+
+If nothing seems to help, consider also using a different client-side terminal application:
+* Linux: xterm, KDE Konsole, GNOME Terminal
+* Mac: Terminal, iTerm2
+* Windows: PowerShell, PuTTY, WSL (Windows Subsystem for Linux)
+
+## "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" 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:  
+`export DOCKER_HOST=tcp://localhost:2375`  
+Alternatively, use the command-line options `-h 127.0.0.1 -p 2375` for commands like `balena build` and `balena deploy`.
+
+Further reference:
+
+- https://techcommunity.microsoft.com/t5/Containers/WSL-Interoperability-with-Docker/ba-p/382405
+- https://forums.docker.com/t/wsl-and-docker-for-windows-cannot-connect-to-the-docker-daemon-at-tcp-localhost-2375-is-the-docker-daemon-running/63571/12

appveyor.yml

@@ -0,0 +1,43 @@
+# 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

@@ -0,0 +1,420 @@
+/**
+ * @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 type { JsonVersions } from '../lib/commands/version';
+
+import { run as oclifRun } from '@oclif/dev-cli';
+import * as archiver from 'archiver';
+import * as Bluebird from 'bluebird';
+import { execFile } from 'child_process';
+import * as filehound from 'filehound';
+import * as fs from 'fs-extra';
+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 { stripIndent } from '../lib/utils/lazy';
+import {
+	diffLines,
+	getSubprocessStdout,
+	loadPackageJson,
+	MSYS2_BASH,
+	ROOT,
+	StdOutTap,
+	whichSpawn,
+} from './utils';
+
+export const packageJSON = loadPackageJson();
+export const version = 'v' + packageJSON.version;
+const arch = process.arch;
+
+function dPath(...paths: string[]) {
+	return path.join(ROOT, 'dist', ...paths);
+}
+
+interface PathByPlatform {
+	[platform: string]: string;
+}
+
+const standaloneZips: PathByPlatform = {
+	linux: dPath(`balena-cli-${version}-linux-${arch}-standalone.zip`),
+	darwin: dPath(`balena-cli-${version}-macOS-${arch}-standalone.zip`),
+	win32: dPath(`balena-cli-${version}-windows-${arch}-standalone.zip`),
+};
+
+const oclifInstallers: PathByPlatform = {
+	darwin: dPath('macos', `balena-${version}.pkg`),
+	win32: dPath('win', `balena-${version}-${arch}.exe`),
+};
+
+const renamedOclifInstallers: PathByPlatform = {
+	darwin: dPath(`balena-cli-${version}-macOS-${arch}-installer.pkg`),
+	win32: dPath(`balena-cli-${version}-windows-${arch}-installer.exe`),
+};
+
+export const finalReleaseAssets: { [platform: string]: string[] } = {
+	win32: [standaloneZips['win32'], renamedOclifInstallers['win32']],
+	darwin: [standaloneZips['darwin'], renamedOclifInstallers['darwin']],
+	linux: [standaloneZips['linux']],
+};
+
+/**
+ * Given the output of `pkg` as a string (containing warning messages),
+ * diff it against previously saved output of known "safe" warnings.
+ * Throw an error if the diff is not empty.
+ */
+async function diffPkgOutput(pkgOut: string) {
+	const { monochrome } = await import('../tests/helpers');
+	const relSavedPath = path.join(
+		'tests',
+		'test-data',
+		'pkg',
+		`expected-warnings-${process.platform}.txt`,
+	);
+	const absSavedPath = path.join(ROOT, relSavedPath);
+	const ignoreStartsWith = [
+		'> pkg@',
+		'> Fetching base Node.js binaries',
+		'  fetched-',
+	];
+	const modulesRE =
+		process.platform === 'win32'
+			? /(?<=[ '])([A-Z]:)?\\.+?\\node_modules(?=\\)/
+			: /(?<=[ '])\/.+?\/node_modules(?=\/)/;
+	const buildRE =
+		process.platform === 'win32'
+			? /(?<=[ '])([A-Z]:)?\\.+\\build(?=\\)/
+			: /(?<=[ '])\/.+\/build(?=\/)/;
+
+	const cleanLines = (chunks: string | string[]) => {
+		const lines = typeof chunks === 'string' ? chunks.split('\n') : chunks;
+		return lines
+			.map((line: string) => monochrome(line)) // remove ASCII colors
+			.filter((line: string) => !/^\s*$/.test(line)) // blank lines
+			.filter((line: string) =>
+				ignoreStartsWith.every((i) => !line.startsWith(i)),
+			)
+			.map((line: string) => {
+				// replace absolute paths with relative paths
+				let replaced = line.replace(modulesRE, 'node_modules');
+				if (replaced === line) {
+					replaced = line.replace(buildRE, 'build');
+				}
+				return replaced;
+			});
+	};
+
+	pkgOut = cleanLines(pkgOut).join('\n');
+	const { readFile } = (await import('fs')).promises;
+	const expectedOut = cleanLines(await readFile(absSavedPath, 'utf8')).join(
+		'\n',
+	);
+	if (expectedOut !== pkgOut) {
+		const sep =
+			'================================================================================';
+		const diff = diffLines(expectedOut, pkgOut);
+		const msg = `pkg output does not match expected output from "${relSavedPath}"
+Diff:
+${sep}
+${diff}
+${sep}
+Check whether the new or changed pkg warnings are safe to ignore, then update
+"${relSavedPath}"
+and share the result of your investigation as comments on the pull request.
+Hint: the fix is often a matter of updating the 'pkg.scripts' or 'pkg.assets'
+sections in the CLI's 'package.json' file, or a matter of updating the
+'buildPkg' function in 'automation/build-bin.ts'.  Sometimes it requires
+patching dependencies: See for example 'patches/all/open+7.0.2.patch'.
+${sep}
+`;
+		throw new Error(msg);
+	}
+}
+
+/**
+ * Call `pkg.exec` to generate the standalone zip file, capturing its warning
+ * messages (stdout and stderr) in order to call diffPkgOutput().
+ */
+async function execPkg(...args: any[]) {
+	const { exec: pkgExec } = await import('pkg');
+	const outTap = new StdOutTap(true);
+	try {
+		outTap.tap();
+		await (pkgExec as any)(...args);
+	} catch (err) {
+		outTap.untap();
+		console.log(outTap.stdoutBuf.join(''));
+		console.error(outTap.stderrBuf.join(''));
+		throw err;
+	}
+	outTap.untap();
+	await diffPkgOutput(outTap.allBuf.join(''));
+}
+
+/**
+ * Use the 'pkg' module to create a single large executable file with
+ * the contents of 'node_modules' and the CLI's javascript code.
+ * Also copy a number of native modules (binary '.node' files) that are
+ * compiled during 'npm install' to the 'build-bin' folder, alongside
+ * the single large executable file created by pkg. (This is necessary
+ * because of a pkg limitation that does not allow binary executables
+ * to be directly executed from inside another binary executable.)
+ */
+async function buildPkg() {
+	const args = [
+		'--target',
+		'host',
+		'--output',
+		'build-bin/balena',
+		'package.json',
+	];
+	console.log('=======================================================');
+	console.log(`execPkg ${args.join(' ')}`);
+	console.log(`cwd="${process.cwd()}" ROOT="${ROOT}"`);
+	console.log('=======================================================');
+
+	await execPkg(args);
+
+	const paths: Array<[string, string[], string[]]> = [
+		// [platform, [source path], [destination path]]
+		['*', ['open', 'xdg-open'], ['xdg-open']],
+		['*', ['opn', 'xdg-open'], ['xdg-open-402']],
+		['darwin', ['denymount', 'bin', 'denymount'], ['denymount']],
+	];
+	await Promise.all(
+		paths.map(([platform, source, dest]) => {
+			if (platform === '*' || platform === process.platform) {
+				// eg copy from node_modules/open/xdg-open to build-bin/xdg-open
+				return fs.copy(
+					path.join(ROOT, 'node_modules', ...source),
+					path.join(ROOT, 'build-bin', ...dest),
+				);
+			}
+		}),
+	);
+	const nativeExtensionPaths: string[] = await filehound
+		.create()
+		.paths(path.join(ROOT, 'node_modules'))
+		.ext(['node', 'dll'])
+		.find();
+
+	console.log(`\nCopying to build-bin:\n${nativeExtensionPaths.join('\n')}`);
+
+	await Promise.all(
+		nativeExtensionPaths.map((extPath) =>
+			fs.copy(
+				extPath,
+				extPath.replace(
+					path.join(ROOT, 'node_modules'),
+					path.join(ROOT, 'build-bin'),
+				),
+			),
+		),
+	);
+}
+
+/**
+ * Run some basic tests on the built pkg executable.
+ * TODO: test more than just `balena version -j`; integrate with the
+ * existing mocha/chai CLI command testing.
+ */
+async function testPkg() {
+	const pkgBalenaPath = path.join(
+		ROOT,
+		'build-bin',
+		process.platform === 'win32' ? 'balena.exe' : 'balena',
+	);
+	console.log(`Testing standalone package "${pkgBalenaPath}"...`);
+	// Run `balena version -j`, parse its stdout as JSON, and check that the
+	// reported Node.js major version matches semver.major(process.version)
+	const stdout = await getSubprocessStdout(pkgBalenaPath, ['version', '-j']);
+	let pkgNodeVersion = '';
+	let pkgNodeMajorVersion = 0;
+	try {
+		const balenaVersions: JsonVersions = JSON.parse(stdout);
+		pkgNodeVersion = balenaVersions['Node.js'];
+		pkgNodeMajorVersion = semver.major(pkgNodeVersion);
+	} catch (err) {
+		throw new Error(stripIndent`
+			Error parsing JSON output of "balena version -j": ${err}
+			Original output: "${stdout}"`);
+	}
+	if (semver.major(process.version) !== pkgNodeMajorVersion) {
+		throw new Error(
+			`Mismatched major version: built-in pkg Node version="${pkgNodeVersion}" vs process.version="${process.version}"`,
+		);
+	}
+	console.log('Success! (standalone package test successful)');
+}
+
+/**
+ * Create the zip file for the standalone 'pkg' bundle previously created
+ * by the buildPkg() function in 'build-bin.ts'.
+ */
+async function zipPkg() {
+	const outputFile = standaloneZips[process.platform];
+	if (!outputFile) {
+		throw new Error(
+			`Standalone installer unavailable for platform "${process.platform}"`,
+		);
+	}
+	await fs.mkdirp(path.dirname(outputFile));
+	await new Promise((resolve, reject) => {
+		console.log(`Zipping standalone package to "${outputFile}"...`);
+
+		const archive = archiver('zip', {
+			zlib: { level: 7 },
+		});
+		archive.directory(path.join(ROOT, 'build-bin'), 'balena-cli');
+
+		const outputStream = fs.createWriteStream(outputFile);
+
+		outputStream.on('close', resolve);
+		outputStream.on('error', reject);
+
+		archive.on('error', reject);
+		archive.on('warning', console.warn);
+
+		archive.pipe(outputStream);
+		archive.finalize();
+	});
+}
+
+export async function buildStandaloneZip() {
+	console.log(`Building standalone zip package for CLI ${version}`);
+	try {
+		await buildPkg();
+		await testPkg();
+		await zipPkg();
+		console.log(`Standalone zip package build completed`);
+	} catch (error) {
+		console.error(`Error creating or testing standalone zip package`);
+		throw error;
+	}
+}
+
+async function renameInstallerFiles() {
+	if (await fs.pathExists(oclifInstallers[process.platform])) {
+		await fs.rename(
+			oclifInstallers[process.platform],
+			renamedOclifInstallers[process.platform],
+		);
+	}
+}
+
+/**
+ * If the CSC_LINK and CSC_KEY_PASSWORD env vars are set, digitally sign the
+ * executable installer by running the balena-io/scripts/shared/sign-exe.sh
+ * script (which must be in the PATH) using a MSYS2 bash shell.
+ */
+async function signWindowsInstaller() {
+	if (process.env.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',
+			'-f',
+			exeName,
+			'-d',
+			`balena-cli ${version}`,
+		]);
+	} else {
+		console.log(
+			'Skipping installer signing step because CSC_* env vars are not set',
+		);
+	}
+}
+
+/**
+ * Run the `oclif-dev pack:win` or `pack:macos` command (depending on the value
+ * of process.platform) to generate the native installers (which end up under
+ * the 'dist' folder). There are some harcoded options such as selecting only
+ * 64-bit binaries under Windows.
+ */
+export async function buildOclifInstaller() {
+	let packOS = '';
+	let packOpts = ['-r', ROOT];
+	if (process.platform === 'darwin') {
+		packOS = 'macos';
+	} else if (process.platform === 'win32') {
+		packOS = 'win';
+		packOpts = packOpts.concat('-t', 'win32-x64');
+	}
+	if (packOS) {
+		console.log(`Building oclif installer for CLI ${version}`);
+		const packCmd = `pack:${packOS}`;
+		const dirs = [path.join(ROOT, 'dist', packOS)];
+		if (packOS === 'win') {
+			dirs.push(path.join(ROOT, 'tmp', 'win*'));
+		}
+		for (const dir of dirs) {
+			console.log(`rimraf(${dir})`);
+			await Bluebird.fromCallback((cb) => rimraf(dir, cb));
+		}
+		console.log('=======================================================');
+		console.log(`oclif-dev "${packCmd}" "${packOpts.join('" "')}"`);
+		console.log(`cwd="${process.cwd()}" ROOT="${ROOT}"`);
+		console.log('=======================================================');
+		await oclifRun([packCmd].concat(...packOpts));
+		await renameInstallerFiles();
+		// The Windows installer is explicitly signed here (oclif doesn't do it).
+		// The macOS installer is automatically signed by oclif (which runs the
+		// `pkgbuild` tool), using the certificate name given in package.json
+		// (`oclif.macos.sign` section).
+		if (process.platform === 'win32') {
+			await signWindowsInstaller();
+		}
+		console.log(`oclif installer build completed`);
+	}
+}
+
+/**
+ * Wrapper around the npm `catch-uncommitted` package in order to run it
+ * conditionally, only when:
+ * - A CI env var is set (CI=true), and
+ * - The OS is not Windows. (`catch-uncommitted` fails on Windows)
+ */
+export async function catchUncommitted(): Promise<void> {
+	if (process.env.DEBUG) {
+		console.error(`[debug] CI=${process.env.CI} platform=${process.platform}`);
+	}
+	if (
+		process.env.CI &&
+		['true', 'yes', '1'].includes(process.env.CI.toLowerCase()) &&
+		process.platform !== 'win32'
+	) {
+		await whichSpawn('npx', [
+			'catch-uncommitted',
+			'--catch-no-git',
+			'--skip-node-versionbot-changes',
+			'--ignore-space-at-eol',
+		]);
+	}
+}
+
+export async function testShrinkwrap(): Promise<void> {
+	if (process.env.DEBUG) {
+		console.error(`[debug] platform=${process.platform}`);
+	}
+	if (process.platform !== 'win32') {
+		await whichSpawn(path.resolve(__dirname, 'test-lock-deduplicated.sh'));
+	}
+}

automation/capitanodoc/capitanodoc.ts

@@ -0,0 +1,210 @@
+/**
+ * @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 path from 'path';
+import { MarkdownFileParser } from './utils';
+
+/**
+ * This is the skeleton of CLI documentation/reference web page at:
+ * https://www.balena.io/docs/reference/cli/
+ *
+ * The `getCapitanoDoc` function in this module parses README.md and adds
+ * some content to this object.
+ */
+const capitanoDoc = {
+	title: 'balena CLI Documentation',
+	introduction: '',
+	categories: [
+		{
+			title: 'API keys',
+			files: ['build/commands/api-key/generate.js'],
+		},
+		{
+			title: 'Application',
+			files: [
+				'build/commands/apps.js',
+				'build/commands/app/index.js',
+				'build/commands/app/create.js',
+				'build/commands/app/purge.js',
+				'build/commands/app/rename.js',
+				'build/commands/app/restart.js',
+				'build/commands/app/rm.js',
+			],
+		},
+		{
+			title: 'Authentication',
+			files: [
+				'build/commands/login.js',
+				'build/commands/logout.js',
+				'build/commands/whoami.js',
+			],
+		},
+		{
+			title: 'Device',
+			files: [
+				'build/commands/devices/index.js',
+				'build/commands/devices/supported.js',
+				'build/commands/device/index.js',
+				'build/commands/device/identify.js',
+				'build/commands/device/init.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: 'Environment Variables',
+			files: [
+				'build/commands/envs.js',
+				'build/commands/env/add.js',
+				'build/commands/env/rename.js',
+				'build/commands/env/rm.js',
+			],
+		},
+		{
+			title: 'Tags',
+			files: [
+				'build/commands/tags.js',
+				'build/commands/tag/rm.js',
+				'build/commands/tag/set.js',
+			],
+		},
+		{
+			title: 'Help and Version',
+			files: ['help', 'build/commands/version.js'],
+		},
+		{
+			title: 'Keys',
+			files: [
+				'build/commands/keys.js',
+				'build/commands/key/index.js',
+				'build/commands/key/add.js',
+				'build/commands/key/rm.js',
+			],
+		},
+		{
+			title: 'Logs',
+			files: ['build/commands/logs.js'],
+		},
+		{
+			title: 'Network',
+			files: [
+				'build/commands/scan.js',
+				'build/commands/ssh.js',
+				'build/commands/tunnel.js',
+			],
+		},
+		{
+			title: 'Notes',
+			files: ['build/commands/note.js'],
+		},
+		{
+			title: 'OS',
+			files: [
+				'build/commands/os/build-config.js',
+				'build/commands/os/configure.js',
+				'build/commands/os/versions.js',
+				'build/commands/os/download.js',
+				'build/commands/os/initialize.js',
+			],
+		},
+		{
+			title: 'Config',
+			files: [
+				'build/commands/config/generate.js',
+				'build/commands/config/inject.js',
+				'build/commands/config/read.js',
+				'build/commands/config/reconfigure.js',
+				'build/commands/config/write.js',
+			],
+		},
+		{
+			title: 'Preload',
+			files: ['build/commands/preload.js'],
+		},
+		{
+			title: 'Push',
+			files: ['build/commands/push.js'],
+		},
+		{
+			title: 'Settings',
+			files: ['build/commands/settings.js'],
+		},
+		{
+			title: 'Local',
+			files: [
+				'build/commands/local/configure.js',
+				'build/commands/local/flash.js',
+			],
+		},
+		{
+			title: 'Deploy',
+			files: ['build/commands/build.js', 'build/commands/deploy.js'],
+		},
+		{
+			title: 'Platform',
+			files: ['build/commands/join.js', 'build/commands/leave.js'],
+		},
+		{
+			title: 'Utilities',
+			files: ['build/commands/util/available-drives.js'],
+		},
+		{
+			title: 'Support',
+			files: ['build/commands/support.js'],
+		},
+	],
+};
+
+/**
+ * Modify and return the `capitanoDoc` object above in order to render the
+ * CLI documentation/reference web page at:
+ * https://www.balena.io/docs/reference/cli/
+ *
+ * This function parses the README.md file to extract relevant sections
+ * for the documentation web page.
+ */
+export async function getCapitanoDoc(): Promise<typeof capitanoDoc> {
+	const readmePath = path.join(__dirname, '..', '..', 'README.md');
+	const mdParser = new MarkdownFileParser(readmePath);
+	const sections: string[] = await Promise.all([
+		mdParser.getSectionOfTitle('About').then((sectionLines: string) => {
+			// delete the title of the 'About' section for the web page
+			const match = /^(#+)\s+.+?\n\s*([^]*)/.exec(sectionLines);
+			if (!match || match.length < 3) {
+				throw new Error(`Error parsing section title`);
+			}
+			// match[1] has the title, match[2] has the rest
+			return match && match[2];
+		}),
+		mdParser.getSectionOfTitle('Installation'),
+		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'),
+	]);
+	capitanoDoc.introduction = sections.join('\n');
+	return capitanoDoc;
+}

automation/capitanodoc/doc-types.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @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 { Command as OclifCommandClass } from '@oclif/command';
+
+type OclifCommand = typeof OclifCommandClass;
+
+export interface Document {
+	title: string;
+	introduction: string;
+	categories: Category[];
+}
+
+export interface Category {
+	title: string;
+	commands: OclifCommand[];
+}
+
+export { OclifCommand };

automation/capitanodoc/index.ts

@@ -0,0 +1,108 @@
+/**
+ * @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 path from 'path';
+import { getCapitanoDoc } from './capitanodoc';
+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
+ * page on the web: https://www.balena.io/docs/reference/cli/
+ */
+export async function renderMarkdown(): Promise<string> {
+	const capitanodoc = await getCapitanoDoc();
+	const result: Document = {
+		title: capitanodoc.title,
+		introduction: capitanodoc.introduction,
+		categories: [],
+	};
+
+	for (const commandCategory of capitanodoc.categories) {
+		const category: Category = {
+			title: commandCategory.title,
+			commands: [],
+		};
+
+		for (const jsFilename of commandCategory.files) {
+			category.commands.push(...importOclifCommands(jsFilename));
+		}
+		result.categories.push(category);
+	}
+
+	return markdown.render(result);
+}
+
+// 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.
+
+		List balena commands, or get detailed help for a specific command.
+	`;
+
+	examples = [
+		'$ balena help',
+		'$ balena help apps',
+		'$ balena help os download',
+	];
+
+	args = [
+		{
+			name: 'command',
+			description: 'command to show help for',
+		},
+	];
+
+	usage = 'help [command]';
+
+	flags = {
+		verbose: {
+			description: 'show additional commands',
+			char: '-v',
+		},
+	};
+}
+
+function importOclifCommands(jsFilename: string): OclifCommand[] {
+	// TODO: Currently oclif commands with no `usage` overridden will cause
+	//  an error when parsed.  This should be improved so that `usage` does not have
+	//  to be overridden if not necessary.
+
+	const command: OclifCommand =
+		jsFilename === 'help'
+			? ((new FakeHelpCommand() as unknown) as OclifCommand)
+			: (require(path.join(process.cwd(), jsFilename)).default as OclifCommand);
+
+	return [command];
+}
+
+/**
+ * Print the CLI docs markdown to stdout.
+ * See package.json for how the output is redirected to a file.
+ */
+async function printMarkdown() {
+	try {
+		console.log(await renderMarkdown());
+	} catch (error) {
+		console.error(error);
+		process.exit(1);
+	}
+}
+
+printMarkdown();

automation/capitanodoc/markdown.ts

@@ -0,0 +1,128 @@
+/**
+ * @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 { flagUsages } from '@oclif/parser';
+import * as ent from 'ent';
+import * as _ from 'lodash';
+
+import { getManualSortCompareFunction } from '../../lib/utils/helpers';
+import { capitanoizeOclifUsage } from '../../lib/utils/oclif-utils';
+import { Category, Document, OclifCommand } from './doc-types';
+
+function renderOclifCommand(command: OclifCommand): string[] {
+	const result = [`## ${ent.encode(command.usage || '')}`];
+	const description = (command.description || '')
+		.split('\n')
+		.slice(1) // remove the first line, which oclif uses as help header
+		.join('\n')
+		.trim();
+	result.push(description);
+
+	if (!_.isEmpty(command.examples)) {
+		result.push('Examples:', command.examples!.map((v) => `\t${v}`).join('\n'));
+	}
+
+	if (!_.isEmpty(command.args)) {
+		result.push('### Arguments');
+		for (const arg of command.args!) {
+			result.push(`#### ${arg.name.toUpperCase()}`, arg.description || '');
+		}
+	}
+
+	if (!_.isEmpty(command.flags)) {
+		result.push('### Options');
+		for (const [name, flag] of Object.entries(command.flags!)) {
+			if (name === 'help') {
+				continue;
+			}
+			flag.name = name;
+			const flagUsage = flagUsages([flag])
+				.map(([usage, _description]) => usage)
+				.join()
+				.trim();
+			result.push(`#### ${flagUsage}`);
+			result.push(flag.description || '');
+		}
+	}
+	return result;
+}
+
+function renderCategory(category: Category): string[] {
+	const result = [`# ${category.title}`];
+	for (const command of category.commands) {
+		result.push(...renderOclifCommand(command));
+	}
+	return result;
+}
+
+function getAnchor(cmdSignature: string): string {
+	return `#${_.trim(cmdSignature.replace(/\W+/g, '-'), '-').toLowerCase()}`;
+}
+
+function renderToc(categories: Category[]): string[] {
+	const result = [`# CLI Command Reference`];
+
+	for (const category of categories) {
+		result.push(`- ${category.title}`);
+		result.push(
+			category.commands
+				.map((command) => {
+					const signature = capitanoizeOclifUsage(command.usage);
+					return `\t- [${ent.encode(signature)}](${getAnchor(signature)})`;
+				})
+				.join('\n'),
+		);
+	}
+	return result;
+}
+
+const manualCategorySorting: { [category: string]: string[] } = {
+	'Environment Variables': ['envs', 'env rm', 'env add', 'env rename'],
+	OS: [
+		'os versions',
+		'os download',
+		'os build config',
+		'os configure',
+		'os initialize',
+	],
+};
+
+function sortCommands(doc: Document): void {
+	for (const category of doc.categories) {
+		if (category.title in manualCategorySorting) {
+			category.commands = category.commands.sort(
+				getManualSortCompareFunction<OclifCommand, string>(
+					manualCategorySorting[category.title],
+					(cmd: OclifCommand, x: string) =>
+						(cmd.usage || '').toString().replace(/\W+/g, ' ').includes(x),
+				),
+			);
+		}
+	}
+}
+
+export function render(doc: Document) {
+	sortCommands(doc);
+	const result = [
+		`# ${doc.title}`,
+		doc.introduction,
+		...renderToc(doc.categories),
+	];
+	for (const category of doc.categories) {
+		result.push(...renderCategory(category));
+	}
+	return result.join('\n\n');
+}

automation/capitanodoc/utils.ts

@@ -0,0 +1,136 @@
+/**
+ * @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 type { OptionDefinition } from 'capitano';
+import * as ent from 'ent';
+import * as fs from 'fs';
+import * as readline from 'readline';
+
+export function getOptionPrefix(signature: string) {
+	if (signature.length > 1) {
+		return '--';
+	} else {
+		return '-';
+	}
+}
+
+export function getOptionSignature(signature: string) {
+	return `${getOptionPrefix(signature)}${signature}`;
+}
+
+export function parseCapitanoOption(option: OptionDefinition): string {
+	let result = getOptionSignature(option.signature);
+
+	if (Array.isArray(option.alias)) {
+		for (const alias of option.alias) {
+			result += `, ${getOptionSignature(alias)}`;
+		}
+	} else if (typeof option.alias === 'string') {
+		result += `, ${getOptionSignature(option.alias)}`;
+	}
+
+	if (option.parameter) {
+		result += ` <${option.parameter}>`;
+	}
+
+	return ent.encode(result);
+}
+
+export class MarkdownFileParser {
+	constructor(public mdFilePath: string) {}
+
+	/**
+	 * Extract the lines of a markdown document section with the given title.
+	 * For example, consider this sample markdown document:
+	 * ```
+	 *     # balena CLI
+	 *
+	 *     ## Introduction
+	 *     Lorem ipsum dolor sit amet, consectetur adipiscing elit,
+	 *
+	 *     ## Getting Started
+	 *     sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+	 *
+	 *     ### Prerequisites
+	 *     - Foo
+	 *     - Bar
+	 *
+	 *     ## Support
+	 *     Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris.
+	 * ```
+	 *
+	 * Calling getSectionOfTitle('Getting Started') for the markdown doc above
+	 * returns everything from line '## Getting Started' (included) to line
+	 * '## Support' (excluded). This method counts the number of '#' characters
+	 * to determine that subsections should be included as part of the parent
+	 * section.
+	 *
+	 * @param title The section title without '#' chars, eg. 'Getting Started'
+	 */
+	public async getSectionOfTitle(
+		title: string,
+		includeSubsections = true,
+	): Promise<string> {
+		let foundSectionLines: string[];
+		let foundSectionLevel = 0;
+
+		const rl = readline.createInterface({
+			input: fs.createReadStream(this.mdFilePath),
+			crlfDelay: Infinity,
+		});
+
+		rl.on('line', (line) => {
+			// try to match a line like "## Getting Started", where the number
+			// of '#' characters is the sectionLevel ('##' -> 2), and the
+			// sectionTitle is "Getting Started"
+			const match = /^(#+)\s+(.+)/.exec(line);
+			if (match) {
+				const sectionLevel = match[1].length;
+				const sectionTitle = match[2];
+
+				// If the target section had already been found: append a line, or end it
+				if (foundSectionLines) {
+					if (!includeSubsections || sectionLevel <= foundSectionLevel) {
+						// end previously found section
+						rl.close();
+					}
+				} else if (sectionTitle === title) {
+					// found the target section
+					foundSectionLevel = sectionLevel;
+					foundSectionLines = [];
+				}
+			}
+			if (foundSectionLines) {
+				foundSectionLines.push(line);
+			}
+		});
+
+		return await new Promise((resolve, reject) => {
+			rl.on('close', () => {
+				if (foundSectionLines) {
+					resolve(foundSectionLines.join('\n'));
+				} else {
+					reject(
+						new Error(
+							`Markdown section not found: title="${title}" file="${this.mdFilePath}"`,
+						),
+					);
+				}
+			});
+		});
+	}
+}

automation/check-doc.js

@@ -0,0 +1,84 @@
+/**
+ * @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.
+ */
+
+const stripIndent = require('common-tags/lib/stripIndent');
+const _ = require('lodash');
+const { promises: fs } = require('fs');
+const path = require('path');
+const simplegit = require('simple-git/promise');
+
+const ROOT = path.normalize(path.join(__dirname, '..'));
+
+/**
+ * Compare the timestamp of cli.markdown with the timestamp of staged files,
+ * issuing an error if cli.markdown is older.
+ * If cli.markdown does not require updating and the developer cannot run
+ * `npm run build` on their laptop, the error message suggests a workaround
+ * using `touch`.
+ */
+async function checkBuildTimestamps() {
+	const git = simplegit(ROOT);
+	const docFile = path.join(ROOT, 'doc', 'cli.markdown');
+	const [docStat, gitStatus] = await Promise.all([
+		fs.stat(docFile),
+		git.status(),
+	]);
+	const stagedFiles = _.uniq([
+		...gitStatus.created,
+		...gitStatus.staged,
+		...gitStatus.renamed.map((o) => o.to),
+	])
+		// select only staged files that start with lib/ or typings/
+		.filter((f) => f.match(/^(lib|typings)[/\\]/))
+		.map((f) => path.join(ROOT, f));
+
+	const fStats = await Promise.all(stagedFiles.map((f) => fs.stat(f)));
+	fStats.forEach((fStat, index) => {
+		if (fStat.mtimeMs > docStat.mtimeMs) {
+			const fPath = stagedFiles[index];
+			throw new Error(stripIndent`
+				--------------------------------------------------------------------------------
+				ERROR: at least one staged file: "${fPath}"
+				has a more recent modification timestamp than the documentation file:
+				"${docFile}"
+
+				This probably means that \`npm run build\` or \`npm test\` have not been executed,
+				and this error can be fixed by doing so. Running \`npm run build\` or \`npm test\`
+				before commiting is required in order to update the CLI markdown documentation
+				(in case any command-line options were updated, added or removed) and also to
+				catch Typescript type check errors sooner and reduce overall waiting time, given
+				that the CI build/tests are currently rather lengthy.
+
+				If you need/wish to bypass this check without running \`npm run build\`, run:
+				  npx touch -am "${docFile}"
+				and then try again.
+				--------------------------------------------------------------------------------
+			`);
+		}
+	});
+}
+
+async function run() {
+	try {
+		await checkBuildTimestamps();
+	} catch (err) {
+		console.error(err.message);
+		process.exitCode = 1;
+	}
+}
+
+run();

automation/check-npm-version.js

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+'use strict';
+
+/**
+ * Check that semver v1 is greater than or equal to semver v2.
+ *
+ * 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.
+ */
+function parseSemver(version) {
+	const match = /v?(\d+)\.(\d+).(\d+)/.exec(version);
+	if (match == null) {
+		throw new Error(`Invalid semver version: ${version}`);
+	}
+	const [, major, minor, patch] = match;
+	return [parseInt(major, 10), parseInt(minor, 10), parseInt(patch, 10)];
+}
+
+function semverGte(v1, v2) {
+	let v1Array = parseSemver(v1);
+	let v2Array = parseSemver(v2);
+	for (let i = 0; i < 3; i++) {
+		if (v1Array[i] < v2Array[i]) {
+			return false;
+		} else if (v1Array[i] > v2Array[i]) {
+			return true;
+		}
+	}
+	return true;
+}
+
+function checkNpmVersion() {
+	const execSync = require('child_process').execSync;
+	const npmVersion = execSync('npm --version').toString().trim();
+	const requiredVersion = '6.9.0';
+	if (!semverGte(npmVersion, requiredVersion)) {
+		// In case you take issue with the error message below:
+		//   "At this point, however, your 'npm-shrinkwrap.json' file has
+		//    already been damaged"
+		// ... and think: "why not add the check to the 'preinstall' hook?",
+		// 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(`\
+-------------------------------------------------------------------------------
+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();

automation/deploy-bin.ts

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

automation/run.ts

@@ -0,0 +1,123 @@
+/**
+ * @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 {
+	buildOclifInstaller,
+	buildStandaloneZip,
+	catchUncommitted,
+	testShrinkwrap,
+} from './build-bin';
+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(
+	process.env.DEBUG?.toLowerCase(),
+)
+	? ''
+	: '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:
+ *     'build:installer'   (to build a native oclif installer)
+ * 	   '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[]) {
+	args = args || process.argv.slice(2);
+	console.log(`automation/run.ts process.argv=[${process.argv}]\n`);
+	console.log(`automation/run.ts args=[${args}]`);
+	if (_.isEmpty(args)) {
+		return exitWithError('missing command-line arguments');
+	}
+	const commands: { [cmd: string]: () => void | Promise<void> } = {
+		'build:installer': buildOclifInstaller,
+		'build:standalone': buildStandaloneZip,
+		'catch-uncommitted': catchUncommitted,
+		'test-shrinkwrap': testShrinkwrap,
+		fix1359: updateDescriptionOfReleasesAffectedByIssue1359,
+		release,
+	};
+	for (const arg of args) {
+		if (!commands.hasOwnProperty(arg)) {
+			return exitWithError(`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
+	// to avoid issues with a 260-char limit on Windows paths (possibly a
+	// limitation of some library used by NSIS), as the "current working dir"
+	// provided by balena CI is a rather long path to start with.
+	if (process.platform === 'win32' && !process.env.BUILD_TMP) {
+		const randID = (await import('crypto'))
+			.randomBytes(6)
+			.toString('base64')
+			.replace(/\+/g, '-')
+			.replace(/\//g, '_'); // base64url (RFC 4648)
+		process.env.BUILD_TMP = `C:\\tmp\\${randID}`;
+	}
+
+	for (const arg of args) {
+		try {
+			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}`);
+		}
+	}
+}
+
+run();

automation/test-lock-deduplicated.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+cp npm-shrinkwrap.json npm-shrinkwrap.json.old
+npm i
+npm dedupe
+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' **";
+  exit 1;
+fi
+
+rm npm-shrinkwrap.json.old

automation/update-module.ts

@@ -0,0 +1,140 @@
+import { exec } from 'child_process';
+import * as semver from 'semver';
+
+const changeTypes = ['major', 'minor', 'patch'] as const;
+
+const validateChangeType = (maybeChangeType: string = 'minor') => {
+	maybeChangeType = maybeChangeType.toLowerCase();
+	switch (maybeChangeType) {
+		case 'patch':
+		case 'minor':
+		case 'major':
+			return maybeChangeType;
+		default:
+			console.error(`Invalid change type: '${maybeChangeType}'`);
+			return process.exit(1);
+	}
+};
+
+const compareSemverChangeType = (oldVersion: string, newVersion: string) => {
+	const oldSemver = semver.parse(oldVersion)!;
+	const newSemver = semver.parse(newVersion)!;
+
+	for (const changeType of changeTypes) {
+		if (oldSemver[changeType] !== newSemver[changeType]) {
+			return changeType;
+		}
+	}
+};
+
+const run = async (cmd: string) => {
+	console.info(`Running '${cmd}'`);
+	return new Promise<{ stdout: string; stderr: string }>((resolve, reject) => {
+		const p = exec(cmd, { encoding: 'utf8' }, (err, stdout, stderr) => {
+			if (err) {
+				reject(err);
+				return;
+			}
+			resolve({ stdout, stderr });
+		});
+		p.stdout.pipe(process.stdout);
+		p.stderr.pipe(process.stderr);
+	});
+};
+
+const getVersion = async (module: string): Promise<string> => {
+	const { stdout } = await run(`npm ls --json --depth 0 ${module}`);
+	return JSON.parse(stdout).dependencies[module].version;
+};
+
+interface Upstream {
+	repo: string;
+	url: string;
+	module?: string;
+}
+
+const getUpstreams = async () => {
+	const fs = await import('fs');
+	const repoYaml = fs.readFileSync(__dirname + '/../repo.yml', 'utf8');
+
+	const yaml = await import('js-yaml');
+	const { upstream } = yaml.safeLoad(repoYaml) as {
+		upstream: Upstream[];
+	};
+
+	return upstream;
+};
+
+const printUsage = (upstreams: Upstream[], upstreamName: string) => {
+	console.error(
+		`
+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() {
+	const upstreams = await getUpstreams();
+
+	if (process.argv.length < 3) {
+		return printUsage(upstreams, '$upstreamName');
+	}
+
+	const upstreamName = process.argv[2];
+
+	const upstream = upstreams.find((v) => v.repo === upstreamName);
+
+	if (!upstream) {
+		console.error(
+			`Invalid upstream name '${upstreamName}', valid options: ${upstreams
+				.map(({ repo }) => repo)
+				.join(', ')}`,
+		);
+		return process.exit(1);
+	}
+
+	if (process.argv.length < 4) {
+		printUsage(upstreams, upstreamName);
+	}
+
+	const packageName = upstream.module || upstream.repo;
+
+	const oldVersion = await getVersion(packageName);
+	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);
+	}
+
+	console.log(`Updated ${upstreamName} from ${oldVersion} to ${newVersion}`);
+	const semverChangeType = compareSemverChangeType(oldVersion, newVersion);
+
+	const changeType = process.argv[4]
+		? // if the caller specified a change type, use that one
+		  validateChangeType(process.argv[4])
+		: // use the same change type as in the dependency, but avoid major bumps
+		semverChangeType && semverChangeType !== 'major'
+		? semverChangeType
+		: 'minor';
+	console.log(`Using Change-type: ${changeType}`);
+
+	let { stdout: currentBranch } = await run('git rev-parse --abbrev-ref HEAD');
+	currentBranch = currentBranch.trim();
+	console.log(`Currenty on branch: '${currentBranch}'`);
+	if (currentBranch === 'master') {
+		await run(`git checkout -b "update-${upstreamName}-${newVersion}"`);
+	}
+
+	await run(`git add package.json npm-shrinkwrap.json`);
+	await run(
+		`git commit --message "Update ${upstreamName} to ${newVersion}" --message "Update ${upstreamName} from ${oldVersion} to ${newVersion}" --message "Change-type: ${changeType}"`,
+	);
+}
+
+main();

automation/utils.ts

@@ -0,0 +1,237 @@
+/**
+ * @license
+ * 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.
+ * 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 { 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 */
+export class StdOutTap {
+	public stdoutBuf: string[] = [];
+	public stderrBuf: string[] = [];
+	public allBuf: string[] = []; // both stdout and stderr
+
+	protected origStdoutWrite: typeof process.stdout.write;
+	protected origStderrWrite: typeof process.stdout.write;
+
+	constructor(protected printDots = false) {}
+
+	tap() {
+		this.origStdoutWrite = process.stdout.write;
+		this.origStderrWrite = process.stderr.write;
+
+		process.stdout.write = (chunk: string, ...args: any[]): boolean => {
+			this.stdoutBuf.push(chunk);
+			this.allBuf.push(chunk);
+			const str = this.printDots ? '.' : chunk;
+			return this.origStdoutWrite.call(process.stdout, str, ...args);
+		};
+
+		process.stderr.write = (chunk: string, ...args: any[]): boolean => {
+			this.stderrBuf.push(chunk);
+			this.allBuf.push(chunk);
+			const str = this.printDots ? '.' : chunk;
+			return this.origStderrWrite.call(process.stderr, str, ...args);
+		};
+	}
+
+	untap() {
+		process.stdout.write = this.origStdoutWrite;
+		process.stderr.write = this.origStderrWrite;
+		if (this.printDots) {
+			console.error('');
+		}
+	}
+}
+
+/**
+ * Diff strings by line, using the 'diff' npm package:
+ * https://www.npmjs.com/package/diff
+ */
+export function diffLines(str1: string, str2: string): string {
+	const { diffTrimmedLines } = require('diff');
+	const diffObjs = diffTrimmedLines(str1, str2);
+	const prefix = (chunk: string, char: string) =>
+		chunk
+			.split('\n')
+			.map((line: string) => `${char} ${line}`)
+			.join('\n');
+	const diffStr = diffObjs
+		.map((part: any) => {
+			return part.added
+				? prefix(part.value, '+')
+				: part.removed
+				? prefix(part.value, '-')
+				: prefix(part.value, ' ');
+		})
+		.join('\n');
+	return diffStr;
+}
+
+export function loadPackageJson() {
+	return require(path.join(ROOT, 'package.json'));
+}
+
+/**
+ * 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
+ * executable in the PATH environment variable. Does not cache the results,
+ * so hash -r is not needed when the PATH changes."
+ *
+ * @param program Basename of a program, for example 'ssh'
+ * @returns The program's full path, e.g. 'C:\WINDOWS\System32\OpenSSH\ssh.EXE'
+ */
+export async function which(program: string): Promise<string> {
+	const whichMod = await import('which');
+	let programPath: string;
+	try {
+		programPath = await whichMod(program);
+	} catch (err) {
+		if (err.code === 'ENOENT') {
+			throw new Error(`'${program}' program not found. Is it installed?`);
+		}
+		throw err;
+	}
+	return programPath;
+}
+
+/**
+ * Call which(programName) and spawn() with the given arguments. Throw an error
+ * if the process exit code is not zero.
+ */
+export async function whichSpawn(
+	programName: string,
+	args?: string[],
+): Promise<void> {
+	const program = await which(programName);
+	let error: Error | undefined;
+	let exitCode: number | undefined;
+	try {
+		exitCode = await new Promise<number>((resolve, reject) => {
+			try {
+				spawn(program, args, { stdio: 'inherit' })
+					.on('error', reject)
+					.on('close', resolve);
+			} catch (err) {
+				reject(err);
+			}
+		});
+	} catch (err) {
+		error = err;
+	}
+	if (error || exitCode) {
+		const msg = [
+			`${programName} failed with exit code ${exitCode}:`,
+			`"${program}" [${args}]`,
+		];
+		if (error) {
+			msg.push(`${error}`);
+		}
+		throw new Error(msg.join('\n'));
+	}
+}

balena-completion.bash

@@ -0,0 +1,73 @@
+#!/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

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

bin/balena-dev

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+
+// ****************************************************************************
+// THIS IS FOR DEV PURPOSES ONLY AND WILL NOT BE PART OF THE PUBLISHED PACKAGE
+// Before opening a PR you should build and test your changes using bin/balena
+// ****************************************************************************
+
+// tslint:disable:no-var-requires
+
+// We boost the threadpool size as ext2fs can deadlock with some
+// operations otherwise, if the pool runs out.
+process.env.UV_THREADPOOL_SIZE = '64';
+
+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-v
+process.on('SIGINT', function () {
+	modifyOclifPaths(true);
+});
+
+// Use fast-boot to cache require lookups, speeding up startup
+require('fast-boot2').start({
+	cacheScope: __dirname + '/..',
+	cacheFile: '.fast-boot.json',
+});
+
+// Set the desired es version for downstream modules that support it
+require('@balena/es-version').set('es2018');
+
+// Note: before ts-node v6.0.0, 'transpile-only' (no type checking) was the
+// default option. We upgraded ts-node and found that adding 'transpile-only'
+// was necessary to avoid a mysterious 'null' error message. On the plus side,
+// it is supposed to run faster. We still benefit from type checking when
+// running 'npm run build'.
+require('ts-node').register({
+	project: path.join(rootDir, 'tsconfig.json'),
+	transpileOnly: true,
+});
+require('../lib/app').run();
+
+// Modify package.json oclif paths from build/ -> lib/, or vice versa
+function modifyOclifPaths(revert) {
+	const fs = require('fs');
+	const packageJsonPath = path.join(rootDir, 'package.json');
+
+	const packageJson = fs.readFileSync(packageJsonPath, 'utf8');
+	const packageObj = JSON.parse(packageJson);
+
+	if (!packageObj.oclif) {
+		return;
+	}
+
+	let oclifSectionText = JSON.stringify(packageObj.oclif);
+	if (!revert) {
+		oclifSectionText = oclifSectionText.replace(/\/build\//g, '/lib/');
+	} else {
+		oclifSectionText = oclifSectionText.replace(/\/lib\//g, '/build/');
+	}
+
+	packageObj.oclif = JSON.parse(oclifSectionText);
+	fs.writeFileSync(
+		packageJsonPath,
+		`${JSON.stringify(packageObj, null, 2)}\n`,
+		'utf8',
+	);
+}

bin/resin

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-require('../build/app');

build/actions/app.js

@@ -1,115 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var commandOptions;
-
-  commandOptions = require('./command-options');
-
-  exports.create = {
-    signature: 'app create <name>',
-    description: 'create an application',
-    help: 'Use this command to create a new resin.io application.\n\nYou can specify the application type with the `--type` option.\nOtherwise, an interactive dropdown will be shown for you to select from.\n\nYou can see a list of supported device types with\n\n	$ resin devices supported\n\nExamples:\n\n	$ resin app create MyApp\n	$ resin app create MyApp --type raspberry-pi',
-    options: [
-      {
-        signature: 'type',
-        parameter: 'type',
-        description: 'application type',
-        alias: 't'
-      }
-    ],
-    permission: 'user',
-    primary: true,
-    action: function(params, options, done) {
-      var patterns, resin;
-      resin = require('resin-sdk');
-      patterns = require('../utils/patterns');
-      return resin.models.application.has(params.name).then(function(hasApplication) {
-        if (hasApplication) {
-          throw new Error('You already have an application with that name!');
-        }
-      }).then(function() {
-        return options.type || patterns.selectDeviceType();
-      }).then(function(deviceType) {
-        return resin.models.application.create(params.name, deviceType);
-      }).then(function(application) {
-        return console.info("Application created: " + application.app_name + " (" + application.device_type + ", id " + application.id + ")");
-      }).nodeify(done);
-    }
-  };
-
-  exports.list = {
-    signature: 'apps',
-    description: 'list all applications',
-    help: 'Use this command to list all your applications.\n\nNotice this command only shows the most important bits of information for each app.\nIf you want detailed information, use resin app <name> instead.\n\nExamples:\n\n	$ resin apps',
-    permission: 'user',
-    primary: true,
-    action: function(params, options, done) {
-      var resin, visuals;
-      resin = require('resin-sdk');
-      visuals = require('resin-cli-visuals');
-      return resin.models.application.getAll().then(function(applications) {
-        return console.log(visuals.table.horizontal(applications, ['id', 'app_name', 'device_type', 'online_devices', 'devices_length']));
-      }).nodeify(done);
-    }
-  };
-
-  exports.info = {
-    signature: 'app <name>',
-    description: 'list a single application',
-    help: 'Use this command to show detailed information for a single application.\n\nExamples:\n\n	$ resin app MyApp',
-    permission: 'user',
-    primary: true,
-    action: function(params, options, done) {
-      var resin, visuals;
-      resin = require('resin-sdk');
-      visuals = require('resin-cli-visuals');
-      return resin.models.application.get(params.name).then(function(application) {
-        return console.log(visuals.table.vertical(application, ["$" + application.app_name + "$", 'id', 'device_type', 'git_repository', 'commit']));
-      }).nodeify(done);
-    }
-  };
-
-  exports.restart = {
-    signature: 'app restart <name>',
-    description: 'restart an application',
-    help: 'Use this command to restart all devices that belongs to a certain application.\n\nExamples:\n\n	$ resin app restart MyApp',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.models.application.restart(params.name).nodeify(done);
-    }
-  };
-
-  exports.remove = {
-    signature: 'app rm <name>',
-    description: 'remove an application',
-    help: 'Use this command to remove a resin.io application.\n\nNotice this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` boolean option.\n\nExamples:\n\n	$ resin app rm MyApp\n	$ resin app rm MyApp --yes',
-    options: [commandOptions.yes],
-    permission: 'user',
-    action: function(params, options, done) {
-      var patterns, resin;
-      resin = require('resin-sdk');
-      patterns = require('../utils/patterns');
-      return patterns.confirm(options.yes, 'Are you sure you want to delete the application?').then(function() {
-        return resin.models.application.remove(params.name);
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/auth.js

@@ -1,163 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  exports.login = {
-    signature: 'login',
-    description: 'login to resin.io',
-    help: 'Use this command to login to your resin.io account.\n\nThis command will prompt you to login using the following login types:\n\n- Web authorization: open your web browser and prompt you to authorize the CLI\nfrom the dashboard.\n\n- Credentials: using email/password and 2FA.\n\n- Token: using the authentication token from the preferences page.\n\nExamples:\n\n	$ resin login\n	$ resin login --web\n	$ resin login --token "..."\n	$ resin login --credentials\n	$ resin login --credentials --email johndoe@gmail.com --password secret',
-    options: [
-      {
-        signature: 'token',
-        description: 'auth token',
-        parameter: 'token',
-        alias: 't'
-      }, {
-        signature: 'web',
-        description: 'web-based login',
-        boolean: true,
-        alias: 'w'
-      }, {
-        signature: 'credentials',
-        description: 'credential-based login',
-        boolean: true,
-        alias: 'c'
-      }, {
-        signature: 'email',
-        parameter: 'email',
-        description: 'email',
-        alias: ['e', 'u']
-      }, {
-        signature: 'password',
-        parameter: 'password',
-        description: 'password',
-        alias: 'p'
-      }
-    ],
-    primary: true,
-    action: function(params, options, done) {
-      var Promise, _, auth, capitano, form, login, messages, patterns, resin;
-      _ = require('lodash');
-      Promise = require('bluebird');
-      capitano = Promise.promisifyAll(require('capitano'));
-      resin = require('resin-sdk');
-      auth = require('resin-cli-auth');
-      form = require('resin-cli-form');
-      patterns = require('../utils/patterns');
-      messages = require('../utils/messages');
-      login = function(options) {
-        if (options.token != null) {
-          return Promise["try"](function() {
-            if (_.isString(options.token)) {
-              return options.token;
-            }
-            return form.ask({
-              message: 'Token (from the preferences page)',
-              name: 'token',
-              type: 'input'
-            });
-          }).then(resin.auth.loginWithToken);
-        } else if (options.credentials) {
-          return patterns.authenticate(options);
-        } else if (options.web) {
-          console.info('Connecting to the web dashboard');
-          return auth.login();
-        }
-        return patterns.askLoginType().then(function(loginType) {
-          if (loginType === 'register') {
-            return capitano.runAsync('signup');
-          }
-          options[loginType] = true;
-          return login(options);
-        });
-      };
-      return resin.settings.get('resinUrl').then(function(resinUrl) {
-        console.log(messages.resinAsciiArt);
-        console.log("\nLogging in to " + resinUrl);
-        return login(options);
-      }).then(resin.auth.whoami).tap(function(username) {
-        console.info("Successfully logged in as: " + username);
-        return console.info("\nNow what?\n\n" + messages.gettingStarted + "\n\nFind out about more super powers by running:\n\n  $ resin help\n\n" + messages.reachingOut);
-      }).nodeify(done);
-    }
-  };
-
-  exports.logout = {
-    signature: 'logout',
-    description: 'logout from resin.io',
-    help: 'Use this command to logout from your resin.io account.o\n\nExamples:\n\n	$ resin logout',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.auth.logout().nodeify(done);
-    }
-  };
-
-  exports.signup = {
-    signature: 'signup',
-    description: 'signup to resin.io',
-    help: 'Use this command to signup for a resin.io account.\n\nIf signup is successful, you\'ll be logged in to your new user automatically.\n\nExamples:\n\n	$ resin signup\n	Email: me@mycompany.com\n	Username: johndoe\n	Password: ***********\n\n	$ resin whoami\n	johndoe',
-    action: function(params, options, done) {
-      var form, resin, validation;
-      resin = require('resin-sdk');
-      form = require('resin-cli-form');
-      validation = require('../utils/validation');
-      return resin.settings.get('resinUrl').then(function(resinUrl) {
-        console.log("\nRegistering to " + resinUrl);
-        return form.run([
-          {
-            message: 'Email:',
-            name: 'email',
-            type: 'input',
-            validate: validation.validateEmail
-          }, {
-            message: 'Username:',
-            name: 'username',
-            type: 'input'
-          }, {
-            message: 'Password:',
-            name: 'password',
-            type: 'password',
-            validate: validation.validatePassword
-          }
-        ]);
-      }).then(resin.auth.register).then(resin.auth.loginWithToken).nodeify(done);
-    }
-  };
-
-  exports.whoami = {
-    signature: 'whoami',
-    description: 'get current username and email address',
-    help: 'Use this command to find out the current logged in username and email address.\n\nExamples:\n\n	$ resin whoami',
-    permission: 'user',
-    action: function(params, options, done) {
-      var Promise, resin, visuals;
-      Promise = require('bluebird');
-      resin = require('resin-sdk');
-      visuals = require('resin-cli-visuals');
-      return Promise.props({
-        username: resin.auth.whoami(),
-        email: resin.auth.getEmail(),
-        url: resin.settings.get('resinUrl')
-      }).then(function(results) {
-        return console.log(visuals.table.vertical(results, ['$account information$', 'username', 'email', 'url']));
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/command-options.js

@@ -1,83 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var _;
-
-  _ = require('lodash');
-
-  exports.yes = {
-    signature: 'yes',
-    description: 'confirm non interactively',
-    boolean: true,
-    alias: 'y'
-  };
-
-  exports.optionalApplication = {
-    signature: 'application',
-    parameter: 'application',
-    description: 'application name',
-    alias: ['a', 'app']
-  };
-
-  exports.application = _.defaults({
-    required: 'You have to specify an application'
-  }, exports.optionalApplication);
-
-  exports.optionalDevice = {
-    signature: 'device',
-    parameter: 'device',
-    description: 'device uuid',
-    alias: 'd'
-  };
-
-  exports.booleanDevice = {
-    signature: 'device',
-    description: 'device',
-    boolean: true,
-    alias: 'd'
-  };
-
-  exports.network = {
-    signature: 'network',
-    parameter: 'network',
-    description: 'network type',
-    alias: 'n'
-  };
-
-  exports.wifiSsid = {
-    signature: 'ssid',
-    parameter: 'ssid',
-    description: 'wifi ssid, if network is wifi',
-    alias: 's'
-  };
-
-  exports.wifiKey = {
-    signature: 'key',
-    parameter: 'key',
-    description: 'wifi key, if network is wifi',
-    alias: 'k'
-  };
-
-  exports.forceUpdateLock = {
-    signature: 'force',
-    description: 'force action if the update lock is set',
-    boolean: true,
-    alias: 'f'
-  };
-
-}).call(this);

build/actions/config.js

@@ -1,241 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var commandOptions;
-
-  commandOptions = require('./command-options');
-
-  exports.read = {
-    signature: 'config read',
-    description: 'read a device configuration',
-    help: 'Use this command to read the config.json file from the mounted filesystem (e.g. SD card) of a provisioned device"\n\nExamples:\n\n	$ resin config read --type raspberry-pi\n	$ resin config read --type raspberry-pi --drive /dev/disk2',
-    options: [
-      {
-        signature: 'type',
-        description: 'device type',
-        parameter: 'type',
-        alias: 't',
-        required: 'You have to specify a device type'
-      }, {
-        signature: 'drive',
-        description: 'drive',
-        parameter: 'drive',
-        alias: 'd'
-      }
-    ],
-    permission: 'user',
-    root: true,
-    action: function(params, options, done) {
-      var Promise, config, prettyjson, umount, visuals;
-      Promise = require('bluebird');
-      config = require('resin-config-json');
-      visuals = require('resin-cli-visuals');
-      umount = Promise.promisifyAll(require('umount'));
-      prettyjson = require('prettyjson');
-      return Promise["try"](function() {
-        return options.drive || visuals.drive('Select the device drive');
-      }).tap(umount.umountAsync).then(function(drive) {
-        return config.read(drive, options.type);
-      }).tap(function(configJSON) {
-        return console.info(prettyjson.render(configJSON));
-      }).nodeify(done);
-    }
-  };
-
-  exports.write = {
-    signature: 'config write <key> <value>',
-    description: 'write a device configuration',
-    help: 'Use this command to write the config.json file to the mounted filesystem (e.g. SD card) of a provisioned device\n\nExamples:\n\n	$ resin config write --type raspberry-pi username johndoe\n	$ resin config write --type raspberry-pi --drive /dev/disk2 username johndoe\n	$ resin config write --type raspberry-pi files.network/settings "..."',
-    options: [
-      {
-        signature: 'type',
-        description: 'device type',
-        parameter: 'type',
-        alias: 't',
-        required: 'You have to specify a device type'
-      }, {
-        signature: 'drive',
-        description: 'drive',
-        parameter: 'drive',
-        alias: 'd'
-      }
-    ],
-    permission: 'user',
-    root: true,
-    action: function(params, options, done) {
-      var Promise, _, config, umount, visuals;
-      Promise = require('bluebird');
-      _ = require('lodash');
-      config = require('resin-config-json');
-      visuals = require('resin-cli-visuals');
-      umount = Promise.promisifyAll(require('umount'));
-      return Promise["try"](function() {
-        return options.drive || visuals.drive('Select the device drive');
-      }).tap(umount.umountAsync).then(function(drive) {
-        return config.read(drive, options.type).then(function(configJSON) {
-          console.info("Setting " + params.key + " to " + params.value);
-          _.set(configJSON, params.key, params.value);
-          return configJSON;
-        }).tap(function() {
-          return umount.umountAsync(drive);
-        }).then(function(configJSON) {
-          return config.write(drive, options.type, configJSON);
-        });
-      }).tap(function() {
-        return console.info('Done');
-      }).nodeify(done);
-    }
-  };
-
-  exports.inject = {
-    signature: 'config inject <file>',
-    description: 'inject a device configuration file',
-    help: 'Use this command to inject a config.json file to the mounted filesystem (e.g. SD card) of a provisioned device"\n\nExamples:\n\n	$ resin config inject my/config.json --type raspberry-pi\n	$ resin config inject my/config.json --type raspberry-pi --drive /dev/disk2',
-    options: [
-      {
-        signature: 'type',
-        description: 'device type',
-        parameter: 'type',
-        alias: 't',
-        required: 'You have to specify a device type'
-      }, {
-        signature: 'drive',
-        description: 'drive',
-        parameter: 'drive',
-        alias: 'd'
-      }
-    ],
-    permission: 'user',
-    root: true,
-    action: function(params, options, done) {
-      var Promise, config, fs, umount, visuals;
-      Promise = require('bluebird');
-      config = require('resin-config-json');
-      visuals = require('resin-cli-visuals');
-      umount = Promise.promisifyAll(require('umount'));
-      fs = Promise.promisifyAll(require('fs'));
-      return Promise["try"](function() {
-        return options.drive || visuals.drive('Select the device drive');
-      }).tap(umount.umountAsync).then(function(drive) {
-        return fs.readFileAsync(params.file, 'utf8').then(JSON.parse).then(function(configJSON) {
-          return config.write(drive, options.type, configJSON);
-        });
-      }).tap(function() {
-        return console.info('Done');
-      }).nodeify(done);
-    }
-  };
-
-  exports.reconfigure = {
-    signature: 'config reconfigure',
-    description: 'reconfigure a provisioned device',
-    help: 'Use this command to reconfigure a provisioned device\n\nExamples:\n\n	$ resin config reconfigure --type raspberry-pi\n	$ resin config reconfigure --type raspberry-pi --advanced\n	$ resin config reconfigure --type raspberry-pi --drive /dev/disk2',
-    options: [
-      {
-        signature: 'type',
-        description: 'device type',
-        parameter: 'type',
-        alias: 't',
-        required: 'You have to specify a device type'
-      }, {
-        signature: 'drive',
-        description: 'drive',
-        parameter: 'drive',
-        alias: 'd'
-      }, {
-        signature: 'advanced',
-        description: 'show advanced commands',
-        boolean: true,
-        alias: 'v'
-      }
-    ],
-    permission: 'user',
-    root: true,
-    action: function(params, options, done) {
-      var Promise, capitano, config, umount, visuals;
-      Promise = require('bluebird');
-      config = require('resin-config-json');
-      visuals = require('resin-cli-visuals');
-      capitano = Promise.promisifyAll(require('capitano'));
-      umount = Promise.promisifyAll(require('umount'));
-      return Promise["try"](function() {
-        return options.drive || visuals.drive('Select the device drive');
-      }).tap(umount.umountAsync).then(function(drive) {
-        return config.read(drive, options.type).get('uuid').tap(function() {
-          return umount.umountAsync(drive);
-        }).then(function(uuid) {
-          var configureCommand;
-          configureCommand = "os configure " + drive + " " + uuid;
-          if (options.advanced) {
-            configureCommand += ' --advanced';
-          }
-          return capitano.runAsync(configureCommand);
-        });
-      }).then(function() {
-        return console.info('Done');
-      }).nodeify(done);
-    }
-  };
-
-  exports.generate = {
-    signature: 'config generate',
-    description: 'generate a config.json file',
-    help: 'Use this command to generate a config.json for a device or application\n\nExamples:\n\n	$ resin config generate --device 7cf02a6\n	$ resin config generate --device 7cf02a6 --output config.json\n	$ resin config generate --app MyApp\n	$ resin config generate --app MyApp --output config.json',
-    options: [
-      commandOptions.optionalApplication, commandOptions.optionalDevice, {
-        signature: 'output',
-        description: 'output',
-        parameter: 'output',
-        alias: 'o'
-      }
-    ],
-    permission: 'user',
-    action: function(params, options, done) {
-      var Promise, _, deviceConfig, form, fs, prettyjson, resin;
-      Promise = require('bluebird');
-      fs = Promise.promisifyAll(require('fs'));
-      resin = require('resin-sdk');
-      _ = require('lodash');
-      form = require('resin-cli-form');
-      deviceConfig = require('resin-device-config');
-      prettyjson = require('prettyjson');
-      if ((options.device == null) && (options.application == null)) {
-        throw new Error('You have to pass either a device or an application.\n\nSee the help page for examples:\n\n  $ resin help config generate');
-      }
-      return Promise["try"](function() {
-        if (options.device != null) {
-          return resin.models.device.get(options.device);
-        }
-        return resin.models.application.get(options.application);
-      }).then(function(resource) {
-        return resin.models.device.getManifestBySlug(resource.device_type).get('options').then(form.run).then(function(answers) {
-          if (resource.uuid != null) {
-            return deviceConfig.getByDevice(resource.uuid, answers);
-          }
-          return deviceConfig.getByApplication(resource.app_name, answers);
-        });
-      }).then(function(config) {
-        if (options.output != null) {
-          return fs.writeFileAsync(options.output, JSON.stringify(config));
-        }
-        return console.log(prettyjson.render(config));
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/device.js

@@ -1,326 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var commandOptions;
-
-  commandOptions = require('./command-options');
-
-  exports.list = {
-    signature: 'devices',
-    description: 'list all devices',
-    help: 'Use this command to list all devices that belong to you.\n\nYou can filter the devices by application by using the `--application` option.\n\nExamples:\n\n	$ resin devices\n	$ resin devices --application MyApp\n	$ resin devices --app MyApp\n	$ resin devices -a MyApp',
-    options: [commandOptions.optionalApplication],
-    permission: 'user',
-    primary: true,
-    action: function(params, options, done) {
-      var Promise, _, resin, visuals;
-      Promise = require('bluebird');
-      _ = require('lodash');
-      resin = require('resin-sdk');
-      visuals = require('resin-cli-visuals');
-      return Promise["try"](function() {
-        if (options.application != null) {
-          return resin.models.device.getAllByApplication(options.application);
-        }
-        return resin.models.device.getAll();
-      }).tap(function(devices) {
-        devices = _.map(devices, function(device) {
-          device.uuid = device.uuid.slice(0, 7);
-          return device;
-        });
-        return console.log(visuals.table.horizontal(devices, ['id', 'uuid', 'name', 'device_type', 'application_name', 'status', 'is_online', 'supervisor_version', 'os_version']));
-      }).nodeify(done);
-    }
-  };
-
-  exports.info = {
-    signature: 'device <uuid>',
-    description: 'list a single device',
-    help: 'Use this command to show information about a single device.\n\nExamples:\n\n	$ resin device 7cf02a6',
-    permission: 'user',
-    primary: true,
-    action: function(params, options, done) {
-      var resin, visuals;
-      resin = require('resin-sdk');
-      visuals = require('resin-cli-visuals');
-      return resin.models.device.get(params.uuid).then(function(device) {
-        return resin.models.device.getStatus(device).then(function(status) {
-          device.status = status;
-          return console.log(visuals.table.vertical(device, ["$" + device.name + "$", 'id', 'device_type', 'status', 'is_online', 'ip_address', 'application_name', 'last_seen', 'uuid', 'commit', 'supervisor_version', 'is_web_accessible', 'note', 'os_version']));
-        });
-      }).nodeify(done);
-    }
-  };
-
-  exports.supported = {
-    signature: 'devices supported',
-    description: 'list all supported devices',
-    help: 'Use this command to get the list of all supported devices\n\nExamples:\n\n	$ resin devices supported',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.models.config.getDeviceTypes().each(function(deviceType) {
-        return console.log(deviceType.slug);
-      }).nodeify(done);
-    }
-  };
-
-  exports.register = {
-    signature: 'device register <application>',
-    description: 'register a device',
-    help: 'Use this command to register a device to an application.\n\nExamples:\n\n	$ resin device register MyApp',
-    permission: 'user',
-    options: [
-      {
-        signature: 'uuid',
-        description: 'custom uuid',
-        parameter: 'uuid',
-        alias: 'u'
-      }
-    ],
-    action: function(params, options, done) {
-      var Promise, resin;
-      Promise = require('bluebird');
-      resin = require('resin-sdk');
-      return resin.models.application.get(params.application).then(function(application) {
-        return Promise["try"](function() {
-          return options.uuid || resin.models.device.generateUUID();
-        }).then(function(uuid) {
-          console.info("Registering to " + application.app_name + ": " + uuid);
-          return resin.models.device.register(application.app_name, uuid);
-        });
-      }).get('uuid').nodeify(done);
-    }
-  };
-
-  exports.remove = {
-    signature: 'device rm <uuid>',
-    description: 'remove a device',
-    help: 'Use this command to remove a device from resin.io.\n\nNotice this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` boolean option.\n\nExamples:\n\n	$ resin device rm 7cf02a6\n	$ resin device rm 7cf02a6 --yes',
-    options: [commandOptions.yes],
-    permission: 'user',
-    action: function(params, options, done) {
-      var patterns, resin;
-      resin = require('resin-sdk');
-      patterns = require('../utils/patterns');
-      return patterns.confirm(options.yes, 'Are you sure you want to delete the device?').then(function() {
-        return resin.models.device.remove(params.uuid);
-      }).nodeify(done);
-    }
-  };
-
-  exports.identify = {
-    signature: 'device identify <uuid>',
-    description: 'identify a device with a UUID',
-    help: 'Use this command to identify a device.\n\nIn the Raspberry Pi, the ACT led is blinked several times.\n\nExamples:\n\n	$ resin device identify 23c73a1',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.models.device.identify(params.uuid).nodeify(done);
-    }
-  };
-
-  exports.reboot = {
-    signature: 'device reboot <uuid>',
-    description: 'restart a device',
-    help: 'Use this command to remotely reboot a device\n\nExamples:\n\n	$ resin device reboot 23c73a1',
-    options: [commandOptions.forceUpdateLock],
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.models.device.reboot(params.uuid, options).nodeify(done);
-    }
-  };
-
-  exports.shutdown = {
-    signature: 'device shutdown <uuid>',
-    description: 'shutdown a device',
-    help: 'Use this command to remotely shutdown a device\n\nExamples:\n\n	$ resin device shutdown 23c73a1',
-    options: [commandOptions.forceUpdateLock],
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.models.device.shutdown(params.uuid, options).nodeify(done);
-    }
-  };
-
-  exports.enableDeviceUrl = {
-    signature: 'device public-url enable <uuid>',
-    description: 'enable public URL for a device',
-    help: 'Use this command to enable public URL for a device\n\nExamples:\n\n	$ resin device public-url enable 23c73a1',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.models.device.enableDeviceUrl(params.uuid).nodeify(done);
-    }
-  };
-
-  exports.disableDeviceUrl = {
-    signature: 'device public-url disable <uuid>',
-    description: 'disable public URL for a device',
-    help: 'Use this command to disable public URL for a device\n\nExamples:\n\n	$ resin device public-url disable 23c73a1',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.models.device.disableDeviceUrl(params.uuid).nodeify(done);
-    }
-  };
-
-  exports.getDeviceUrl = {
-    signature: 'device public-url <uuid>',
-    description: 'gets the public URL of a device',
-    help: 'Use this command to get the public URL of a device\n\nExamples:\n\n	$ resin device public-url 23c73a1',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.models.device.getDeviceUrl(params.uuid).then(function(url) {
-        return console.log(url);
-      }).nodeify(done);
-    }
-  };
-
-  exports.hasDeviceUrl = {
-    signature: 'device public-url status <uuid>',
-    description: 'Returns true if public URL is enabled for a device',
-    help: 'Use this command to determine if public URL is enabled for a device\n\nExamples:\n\n	$ resin device public-url status 23c73a1',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin;
-      resin = require('resin-sdk');
-      return resin.models.device.hasDeviceUrl(params.uuid).then(function(hasDeviceUrl) {
-        return console.log(hasDeviceUrl);
-      }).nodeify(done);
-    }
-  };
-
-  exports.rename = {
-    signature: 'device rename <uuid> [newName]',
-    description: 'rename a resin device',
-    help: 'Use this command to rename a device.\n\nIf you omit the name, you\'ll get asked for it interactively.\n\nExamples:\n\n	$ resin device rename 7cf02a6\n	$ resin device rename 7cf02a6 MyPi',
-    permission: 'user',
-    action: function(params, options, done) {
-      var Promise, _, form, resin;
-      Promise = require('bluebird');
-      _ = require('lodash');
-      resin = require('resin-sdk');
-      form = require('resin-cli-form');
-      return Promise["try"](function() {
-        if (!_.isEmpty(params.newName)) {
-          return params.newName;
-        }
-        return form.ask({
-          message: 'How do you want to name this device?',
-          type: 'input'
-        });
-      }).then(_.partial(resin.models.device.rename, params.uuid)).nodeify(done);
-    }
-  };
-
-  exports.move = {
-    signature: 'device move <uuid>',
-    description: 'move a device to another application',
-    help: 'Use this command to move a device to another application you own.\n\nIf you omit the application, you\'ll get asked for it interactively.\n\nExamples:\n\n	$ resin device move 7cf02a6\n	$ resin device move 7cf02a6 --application MyNewApp',
-    permission: 'user',
-    options: [commandOptions.optionalApplication],
-    action: function(params, options, done) {
-      var _, patterns, resin;
-      resin = require('resin-sdk');
-      _ = require('lodash');
-      patterns = require('../utils/patterns');
-      return resin.models.device.get(params.uuid).then(function(device) {
-        return options.application || patterns.selectApplication(function(application) {
-          return _.all([application.device_type === device.device_type, device.application_name !== application.app_name]);
-        });
-      }).tap(function(application) {
-        return resin.models.device.move(params.uuid, application);
-      }).then(function(application) {
-        return console.info(params.uuid + " was moved to " + application);
-      }).nodeify(done);
-    }
-  };
-
-  exports.init = {
-    signature: 'device init',
-    description: 'initialise a device with resin os',
-    help: 'Use this command to download the OS image of a certain application and write it to an SD Card.\n\nNotice this command may ask for confirmation interactively.\nYou can avoid this by passing the `--yes` boolean option.\n\nExamples:\n\n	$ resin device init\n	$ resin device init --application MyApp',
-    options: [
-      commandOptions.optionalApplication, commandOptions.yes, {
-        signature: 'advanced',
-        description: 'enable advanced configuration',
-        boolean: true,
-        alias: 'v'
-      }
-    ],
-    permission: 'user',
-    action: function(params, options, done) {
-      var Promise, capitano, helpers, patterns, resin, rimraf, tmp;
-      Promise = require('bluebird');
-      capitano = Promise.promisifyAll(require('capitano'));
-      rimraf = Promise.promisify(require('rimraf'));
-      tmp = Promise.promisifyAll(require('tmp'));
-      tmp.setGracefulCleanup();
-      resin = require('resin-sdk');
-      helpers = require('../utils/helpers');
-      patterns = require('../utils/patterns');
-      return Promise["try"](function() {
-        if (options.application != null) {
-          return options.application;
-        }
-        return patterns.selectApplication();
-      }).then(resin.models.application.get).then(function(application) {
-        var download;
-        download = function() {
-          return tmp.tmpNameAsync().then(function(temporalPath) {
-            return capitano.runAsync("os download " + application.device_type + " --output " + temporalPath);
-          }).disposer(function(temporalPath) {
-            return rimraf(temporalPath);
-          });
-        };
-        return Promise.using(download(), function(temporalPath) {
-          return capitano.runAsync("device register " + application.app_name).then(resin.models.device.get).tap(function(device) {
-            var configure;
-            configure = "os configure " + temporalPath + " " + device.uuid;
-            if (options.advanced) {
-              configure += ' --advanced';
-            }
-            return capitano.runAsync(configure).then(function() {
-              var message;
-              message = 'Initializing a device requires administrative permissions\ngiven that we need to access raw devices directly.\n';
-              return helpers.sudo(['os', 'initialize', temporalPath, '--type', application.device_type], message);
-            })["catch"](function(error) {
-              return resin.models.device.remove(device.uuid)["finally"](function() {
-                throw error;
-              });
-            });
-          });
-        }).then(function(device) {
-          console.log('Done');
-          return device.uuid;
-        });
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/enter.js

@@ -1,87 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var getSubShellCommand;
-
-  getSubShellCommand = function(command) {
-    var os;
-    os = require('os');
-    if (os.platform() === 'win32') {
-      return {
-        program: 'sh',
-        args: ['-c', command]
-      };
-    } else {
-      return {
-        program: '/bin/sh',
-        args: ['-c', command]
-      };
-    }
-  };
-
-  module.exports = {
-    signature: 'enter <uuid>',
-    description: '(beta) get a shell into the running app container of a device',
-    help: 'Use this command to get a shell into the running application container of\nyour device.\n\nExamples:\n\n	$ resin enter 7cf02a6\n	$ resin enter 7cf02a6 --port 8080',
-    permission: 'user',
-    primary: true,
-    options: [
-      {
-        signature: 'port',
-        parameter: 'port',
-        description: 'ssh port',
-        alias: 't'
-      }
-    ],
-    action: function(params, options, done) {
-      var Promise, child_process, resin, settings;
-      child_process = require('child_process');
-      Promise = require('bluebird');
-      resin = require('resin-sdk');
-      settings = require('resin-settings-client');
-      if (options.port == null) {
-        options.port = 22;
-      }
-      console.info("Connecting with: " + params.uuid);
-      return Promise.props({
-        isOnline: resin.models.device.isOnline(params.uuid),
-        username: resin.auth.whoami(),
-        uuid: resin.models.device.get(params.uuid).get('uuid'),
-        containerId: resin.models.device.getApplicationInfo(params.uuid).get('containerId')
-      }).then(function(arg) {
-        var containerId, isOnline, username, uuid;
-        isOnline = arg.isOnline, username = arg.username, uuid = arg.uuid, containerId = arg.containerId;
-        if (!isOnline) {
-          throw new Error('Device is not online');
-        }
-        if (containerId == null) {
-          throw new Error('Did not find running application container');
-        }
-        return Promise["try"](function() {
-          var command, spawn, subShellCommand;
-          command = "ssh -t -p " + options.port + " " + username + "@" + (settings.get('proxyUrl')) + " enter " + uuid + " " + containerId;
-          subShellCommand = getSubShellCommand(command);
-          return spawn = child_process.spawn(subShellCommand.program, subShellCommand.args, {
-            stdio: 'inherit'
-          });
-        });
-      });
-    }
-  };
-
-}).call(this);

build/actions/environment-variables.js

@@ -1,134 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var commandOptions;
-
-  commandOptions = require('./command-options');
-
-  exports.list = {
-    signature: 'envs',
-    description: 'list all environment variables',
-    help: 'Use this command to list all environment variables for\na particular application or device.\n\nThis command lists all custom environment variables.\nIf you want to see all environment variables, including private\nones used by resin, use the verbose option.\n\nExample:\n\n	$ resin envs --application MyApp\n	$ resin envs --application MyApp --verbose\n	$ resin envs --device 7cf02a6',
-    options: [
-      commandOptions.optionalApplication, commandOptions.optionalDevice, {
-        signature: 'verbose',
-        description: 'show private environment variables',
-        boolean: true,
-        alias: 'v'
-      }
-    ],
-    permission: 'user',
-    action: function(params, options, done) {
-      var Promise, _, resin, visuals;
-      Promise = require('bluebird');
-      _ = require('lodash');
-      resin = require('resin-sdk');
-      visuals = require('resin-cli-visuals');
-      return Promise["try"](function() {
-        if (options.application != null) {
-          return resin.models.environmentVariables.getAllByApplication(options.application);
-        } else if (options.device != null) {
-          return resin.models.environmentVariables.device.getAll(options.device);
-        } else {
-          throw new Error('You must specify an application or device');
-        }
-      }).tap(function(environmentVariables) {
-        var isSystemVariable;
-        if (_.isEmpty(environmentVariables)) {
-          throw new Error('No environment variables found');
-        }
-        if (!options.verbose) {
-          isSystemVariable = resin.models.environmentVariables.isSystemVariable;
-          environmentVariables = _.reject(environmentVariables, isSystemVariable);
-        }
-        return console.log(visuals.table.horizontal(environmentVariables, ['id', 'name', 'value']));
-      }).nodeify(done);
-    }
-  };
-
-  exports.remove = {
-    signature: 'env rm <id>',
-    description: 'remove an environment variable',
-    help: 'Use this command to remove an environment variable from an application.\n\nDon\'t remove resin specific variables, as things might not work as expected.\n\nNotice this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` boolean option.\n\nIf you want to eliminate a device environment variable, pass the `--device` boolean option.\n\nExamples:\n\n	$ resin env rm 215\n	$ resin env rm 215 --yes\n	$ resin env rm 215 --device',
-    options: [commandOptions.yes, commandOptions.booleanDevice],
-    permission: 'user',
-    action: function(params, options, done) {
-      var patterns, resin;
-      resin = require('resin-sdk');
-      patterns = require('../utils/patterns');
-      return patterns.confirm(options.yes, 'Are you sure you want to delete the environment variable?').then(function() {
-        if (options.device) {
-          return resin.models.environmentVariables.device.remove(params.id);
-        } else {
-          return resin.models.environmentVariables.remove(params.id);
-        }
-      }).nodeify(done);
-    }
-  };
-
-  exports.add = {
-    signature: 'env add <key> [value]',
-    description: 'add an environment variable',
-    help: 'Use this command to add an enviroment variable to an application.\n\nIf value is omitted, the tool will attempt to use the variable\'s value\nas defined in your host machine.\n\nUse the `--device` option if you want to assign the environment variable\nto a specific device.\n\nIf the value is grabbed from the environment, a warning message will be printed.\nUse `--quiet` to remove it.\n\nExamples:\n\n	$ resin env add EDITOR vim --application MyApp\n	$ resin env add TERM --application MyApp\n	$ resin env add EDITOR vim --device 7cf02a6',
-    options: [commandOptions.optionalApplication, commandOptions.optionalDevice],
-    permission: 'user',
-    action: function(params, options, done) {
-      var Promise, resin;
-      Promise = require('bluebird');
-      resin = require('resin-sdk');
-      return Promise["try"](function() {
-        if (params.value == null) {
-          params.value = process.env[params.key];
-          if (params.value == null) {
-            throw new Error("Environment value not found for key: " + params.key);
-          } else {
-            console.info("Warning: using " + params.key + "=" + params.value + " from host environment");
-          }
-        }
-        if (options.application != null) {
-          return resin.models.environmentVariables.create(options.application, params.key, params.value);
-        } else if (options.device != null) {
-          return resin.models.environmentVariables.device.create(options.device, params.key, params.value);
-        } else {
-          throw new Error('You must specify an application or device');
-        }
-      }).nodeify(done);
-    }
-  };
-
-  exports.rename = {
-    signature: 'env rename <id> <value>',
-    description: 'rename an environment variable',
-    help: 'Use this command to rename an enviroment variable from an application.\n\nPass the `--device` boolean option if you want to rename a device environment variable.\n\nExamples:\n\n	$ resin env rename 376 emacs\n	$ resin env rename 376 emacs --device',
-    permission: 'user',
-    options: [commandOptions.booleanDevice],
-    action: function(params, options, done) {
-      var Promise, resin;
-      Promise = require('bluebird');
-      resin = require('resin-sdk');
-      return Promise["try"](function() {
-        if (options.device) {
-          return resin.models.environmentVariables.device.update(params.id, params.value);
-        } else {
-          return resin.models.environmentVariables.update(params.id, params.value);
-        }
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/help.js

@@ -1,136 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var _, capitano, columnify, command, general, indent, messages, parse, print;
-
-  _ = require('lodash');
-
-  _.str = require('underscore.string');
-
-  capitano = require('capitano');
-
-  columnify = require('columnify');
-
-  messages = require('../utils/messages');
-
-  parse = function(object) {
-    return _.object(_.map(object, function(item) {
-      var signature;
-      if (item.alias != null) {
-        signature = item.toString();
-      } else {
-        signature = item.signature.toString();
-      }
-      return [signature, item.description];
-    }));
-  };
-
-  indent = function(text) {
-    text = _.map(_.str.lines(text), function(line) {
-      return '    ' + line;
-    });
-    return text.join('\n');
-  };
-
-  print = function(data) {
-    return console.log(indent(columnify(data, {
-      showHeaders: false,
-      minWidth: 35
-    })));
-  };
-
-  general = function(params, options, done) {
-    var commands, groupedCommands;
-    console.log('Usage: resin [COMMAND] [OPTIONS]\n');
-    console.log(messages.gettingStarted + "\n");
-    console.log(messages.reachingOut);
-    console.log('\nPrimary commands:\n');
-    commands = _.reject(capitano.state.commands, function(command) {
-      return command.isWildcard();
-    });
-    groupedCommands = _.groupBy(commands, function(command) {
-      if (command.plugin) {
-        return 'plugins';
-      } else if (command.primary) {
-        return 'primary';
-      }
-      return 'secondary';
-    });
-    print(parse(groupedCommands.primary));
-    if (options.verbose) {
-      if (!_.isEmpty(groupedCommands.plugins)) {
-        console.log('\nInstalled plugins:\n');
-        print(parse(groupedCommands.plugins));
-      }
-      console.log('\nAdditional commands:\n');
-      print(parse(groupedCommands.secondary));
-    } else {
-      console.log('\nRun `resin help --verbose` to list additional commands');
-    }
-    if (!_.isEmpty(capitano.state.globalOptions)) {
-      console.log('\nGlobal Options:\n');
-      print(parse(capitano.state.globalOptions));
-    }
-    return done();
-  };
-
-  command = function(params, options, done) {
-    return capitano.state.getMatchCommand(params.command, function(error, command) {
-      if (error != null) {
-        return done(error);
-      }
-      if ((command == null) || command.isWildcard()) {
-        return done(new Error("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" + (_.str.humanize(command.description)));
-      }
-      if (!_.isEmpty(command.options)) {
-        console.log('\nOptions:\n');
-        print(parse(command.options));
-      }
-      return done();
-    });
-  };
-
-  exports.help = {
-    signature: 'help [command...]',
-    description: 'show help',
-    help: 'Get detailed help for an specific command.\n\nExamples:\n\n	$ resin help apps\n	$ resin help os download',
-    primary: true,
-    options: [
-      {
-        signature: 'verbose',
-        description: 'show additional commands',
-        boolean: true,
-        alias: 'v'
-      }
-    ],
-    action: function(params, options, done) {
-      if (params.command != null) {
-        return command(params, options, done);
-      } else {
-        return general(params, options, done);
-      }
-    }
-  };
-
-}).call(this);

build/actions/index.js

@@ -1,37 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  module.exports = {
-    wizard: require('./wizard'),
-    app: require('./app'),
-    info: require('./info'),
-    auth: require('./auth'),
-    device: require('./device'),
-    env: require('./environment-variables'),
-    keys: require('./keys'),
-    logs: require('./logs'),
-    notes: require('./notes'),
-    help: require('./help'),
-    os: require('./os'),
-    settings: require('./settings'),
-    config: require('./config'),
-    sync: require('./sync'),
-    ssh: require('./ssh')
-  };
-
-}).call(this);

build/actions/info.js

@@ -1,31 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  exports.version = {
-    signature: 'version',
-    description: 'output the version number',
-    help: 'Display the Resin CLI version.',
-    action: function(params, options, done) {
-      var packageJSON;
-      packageJSON = require('../../package.json');
-      console.log(packageJSON.version);
-      return done();
-    }
-  };
-
-}).call(this);

build/actions/keys.js

@@ -1,97 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var commandOptions;
-
-  commandOptions = require('./command-options');
-
-  exports.list = {
-    signature: 'keys',
-    description: 'list all ssh keys',
-    help: 'Use this command to list all your SSH keys.\n\nExamples:\n\n	$ resin keys',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin, visuals;
-      resin = require('resin-sdk');
-      visuals = require('resin-cli-visuals');
-      return resin.models.key.getAll().then(function(keys) {
-        return console.log(visuals.table.horizontal(keys, ['id', 'title']));
-      }).nodeify(done);
-    }
-  };
-
-  exports.info = {
-    signature: 'key <id>',
-    description: 'list a single ssh key',
-    help: 'Use this command to show information about a single SSH key.\n\nExamples:\n\n	$ resin key 17',
-    permission: 'user',
-    action: function(params, options, done) {
-      var resin, visuals;
-      resin = require('resin-sdk');
-      visuals = require('resin-cli-visuals');
-      return resin.models.key.get(params.id).then(function(key) {
-        console.log(visuals.table.vertical(key, ['id', 'title']));
-        return console.log('\n' + key.public_key);
-      }).nodeify(done);
-    }
-  };
-
-  exports.remove = {
-    signature: 'key rm <id>',
-    description: 'remove a ssh key',
-    help: 'Use this command to remove a SSH key from resin.io.\n\nNotice this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` boolean option.\n\nExamples:\n\n	$ resin key rm 17\n	$ resin key rm 17 --yes',
-    options: [commandOptions.yes],
-    permission: 'user',
-    action: function(params, options, done) {
-      var patterns, resin;
-      resin = require('resin-sdk');
-      patterns = require('../utils/patterns');
-      return patterns.confirm(options.yes, 'Are you sure you want to delete the key?').then(function() {
-        return resin.models.key.remove(params.id);
-      }).nodeify(done);
-    }
-  };
-
-  exports.add = {
-    signature: 'key add <name> [path]',
-    description: 'add a SSH key to resin.io',
-    help: 'Use this command to associate a new SSH key with your account.\n\nIf `path` is omitted, the command will attempt\nto read the SSH key from stdin.\n\nExamples:\n\n	$ resin key add Main ~/.ssh/id_rsa.pub\n	$ cat ~/.ssh/id_rsa.pub | resin key add Main',
-    permission: 'user',
-    action: function(params, options, done) {
-      var Promise, _, capitano, fs, resin;
-      _ = require('lodash');
-      Promise = require('bluebird');
-      fs = Promise.promisifyAll(require('fs'));
-      capitano = require('capitano');
-      resin = require('resin-sdk');
-      return Promise["try"](function() {
-        if (params.path != null) {
-          return fs.readFileAsync(params.path, {
-            encoding: 'utf8'
-          });
-        }
-        return Promise.fromNode(function(callback) {
-          return capitano.utils.getStdin(function(data) {
-            return callback(null, data);
-          });
-        });
-      }).then(_.partial(resin.models.key.create, params.name)).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/logs.js

@@ -1,58 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  module.exports = {
-    signature: 'logs <uuid>',
-    description: 'show device logs',
-    help: 'Use this command to show logs for a specific device.\n\nBy default, the command prints all log messages and exit.\n\nTo continuously stream output, and see new logs in real time, use the `--tail` option.\n\nNote that for now you need to provide the whole UUID for this command to work correctly.\n\nThis is due to some technical limitations that we plan to address soon.\n\nExamples:\n\n	$ resin logs 23c73a1\n	$ resin logs 23c73a1',
-    options: [
-      {
-        signature: 'tail',
-        description: 'continuously stream output',
-        boolean: true,
-        alias: 't'
-      }
-    ],
-    permission: 'user',
-    primary: true,
-    action: function(params, options, done) {
-      var _, moment, printLine, promise, resin;
-      _ = require('lodash');
-      resin = require('resin-sdk');
-      moment = require('moment');
-      printLine = function(line) {
-        var timestamp;
-        timestamp = moment(line.timestamp).format('DD.MM.YY HH:mm:ss (ZZ)');
-        return console.log(timestamp + " " + line.message);
-      };
-      promise = resin.logs.history(params.uuid).each(printLine);
-      if (!options.tail) {
-        return promise["catch"](done)["finally"](function() {
-          return process.exit(0);
-        });
-      }
-      return promise.then(function() {
-        return resin.logs.subscribe(params.uuid).then(function(logs) {
-          logs.on('line', printLine);
-          return logs.on('error', done);
-        });
-      })["catch"](done);
-    }
-  };
-
-}).call(this);

build/actions/notes.js

@@ -1,47 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  exports.set = {
-    signature: 'note <|note>',
-    description: 'set a device note',
-    help: 'Use this command to set or update a device note.\n\nIf note command isn\'t passed, the tool attempts to read from `stdin`.\n\nTo view the notes, use $ resin device <uuid>.\n\nExamples:\n\n	$ resin note "My useful note" --device 7cf02a6\n	$ cat note.txt | resin note --device 7cf02a6',
-    options: [
-      {
-        signature: 'device',
-        parameter: 'device',
-        description: 'device uuid',
-        alias: ['d', 'dev'],
-        required: 'You have to specify a device'
-      }
-    ],
-    permission: 'user',
-    action: function(params, options, done) {
-      var Promise, _, resin;
-      Promise = require('bluebird');
-      _ = require('lodash');
-      resin = require('resin-sdk');
-      return Promise["try"](function() {
-        if (_.isEmpty(params.note)) {
-          throw new Error('Missing note content');
-        }
-        return resin.models.device.note(options.device, params.note);
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/os.js

@@ -1,193 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var commandOptions, stepHandler;
-
-  commandOptions = require('./command-options');
-
-  exports.download = {
-    signature: 'os download <type>',
-    description: 'download an unconfigured os image',
-    help: 'Use this command to download an unconfigured os image for a certain device type.\n\nExamples:\n\n	$ resin os download parallella -o ../foo/bar/parallella.img',
-    permission: 'user',
-    options: [
-      {
-        signature: 'output',
-        description: 'output path',
-        parameter: 'output',
-        alias: 'o',
-        required: 'You have to specify an output location'
-      }
-    ],
-    action: function(params, options, done) {
-      var fs, manager, rindle, unzip, visuals;
-      unzip = require('unzip2');
-      fs = require('fs');
-      rindle = require('rindle');
-      manager = require('resin-image-manager');
-      visuals = require('resin-cli-visuals');
-      console.info("Getting device operating system for " + params.type);
-      return manager.get(params.type).then(function(stream) {
-        var bar, output, spinner;
-        bar = new visuals.Progress('Downloading Device OS');
-        spinner = new visuals.Spinner('Downloading Device OS (size unknown)');
-        stream.on('progress', function(state) {
-          if (state != null) {
-            return bar.update(state);
-          } else {
-            return spinner.start();
-          }
-        });
-        stream.on('end', function() {
-          return spinner.stop();
-        });
-        if (stream.mime === 'application/zip') {
-          output = unzip.Extract({
-            path: options.output
-          });
-        } else {
-          output = fs.createWriteStream(options.output);
-        }
-        return rindle.wait(stream.pipe(output))["return"](options.output);
-      }).tap(function(output) {
-        return console.info('The image was downloaded successfully');
-      }).nodeify(done);
-    }
-  };
-
-  stepHandler = function(step) {
-    var _, bar, helpers, rindle, visuals;
-    _ = require('lodash');
-    rindle = require('rindle');
-    visuals = require('resin-cli-visuals');
-    helpers = require('../utils/helpers');
-    step.on('stdout', _.bind(process.stdout.write, process.stdout));
-    step.on('stderr', _.bind(process.stderr.write, process.stderr));
-    step.on('state', function(state) {
-      if (state.operation.command === 'burn') {
-        return;
-      }
-      return console.log(helpers.stateToString(state));
-    });
-    bar = new visuals.Progress('Writing Device OS');
-    step.on('burn', _.bind(bar.update, bar));
-    return rindle.wait(step);
-  };
-
-  exports.configure = {
-    signature: 'os configure <image> <uuid>',
-    description: 'configure an os image',
-    help: 'Use this command to configure a previously download operating system image with a device.\n\nExamples:\n\n	$ resin os configure ../path/rpi.img 7cf02a6',
-    permission: 'user',
-    options: [
-      {
-        signature: 'advanced',
-        description: 'show advanced commands',
-        boolean: true,
-        alias: 'v'
-      }
-    ],
-    action: function(params, options, done) {
-      var _, form, helpers, init, resin;
-      _ = require('lodash');
-      resin = require('resin-sdk');
-      form = require('resin-cli-form');
-      init = require('resin-device-init');
-      helpers = require('../utils/helpers');
-      console.info('Configuring operating system image');
-      return resin.models.device.get(params.uuid).then(function(device) {
-        return helpers.getManifest(params.image, device.device_type).get('options').then(function(questions) {
-          var advancedGroup, override;
-          if (!options.advanced) {
-            advancedGroup = _.findWhere(questions, {
-              name: 'advanced',
-              isGroup: true
-            });
-            if (advancedGroup != null) {
-              override = helpers.getGroupDefaults(advancedGroup);
-            }
-          }
-          return form.run(questions, {
-            override: override
-          });
-        }).then(function(answers) {
-          return init.configure(params.image, params.uuid, answers).then(stepHandler);
-        });
-      }).nodeify(done);
-    }
-  };
-
-  exports.initialize = {
-    signature: 'os initialize <image>',
-    description: 'initialize an os image',
-    help: 'Use this command to initialize a previously configured operating system image.\n\nExamples:\n\n	$ resin os initialize ../path/rpi.img --type \'raspberry-pi\'',
-    permission: 'user',
-    options: [
-      commandOptions.yes, {
-        signature: 'type',
-        description: 'device type',
-        parameter: 'type',
-        alias: 't',
-        required: 'You have to specify a device type'
-      }, {
-        signature: 'drive',
-        description: 'drive',
-        parameter: 'drive',
-        alias: 'd'
-      }
-    ],
-    root: true,
-    action: function(params, options, done) {
-      var Promise, form, helpers, init, patterns, umount;
-      Promise = require('bluebird');
-      umount = Promise.promisifyAll(require('umount'));
-      form = require('resin-cli-form');
-      init = require('resin-device-init');
-      patterns = require('../utils/patterns');
-      helpers = require('../utils/helpers');
-      console.info('Initializing device');
-      return helpers.getManifest(params.image, options.type).then(function(manifest) {
-        var ref;
-        return (ref = manifest.initialization) != null ? ref.options : void 0;
-      }).then(function(questions) {
-        return form.run(questions, {
-          override: {
-            drive: options.drive
-          }
-        });
-      }).tap(function(answers) {
-        var message;
-        if (answers.drive == null) {
-          return;
-        }
-        message = "This will erase " + answers.drive + ". Are you sure?";
-        return patterns.confirm(options.yes, message)["return"](answers.drive).then(umount.umountAsync);
-      }).tap(function(answers) {
-        return init.initialize(params.image, options.type, answers).then(stepHandler);
-      }).then(function(answers) {
-        if (answers.drive == null) {
-          return;
-        }
-        return umount.umountAsync(answers.drive).tap(function() {
-          return console.info("You can safely remove " + answers.drive + " now");
-        });
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/settings.js

@@ -1,31 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  exports.list = {
-    signature: 'settings',
-    description: 'print current settings',
-    help: 'Use this command to display detected settings\n\nExamples:\n\n	$ resin settings',
-    action: function(params, options, done) {
-      var prettyjson, resin;
-      resin = require('resin-sdk');
-      prettyjson = require('prettyjson');
-      return resin.settings.getAll().then(prettyjson.render).then(console.log).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/ssh.js

@@ -1,102 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var getSubShellCommand;
-
-  getSubShellCommand = function(command) {
-    var os;
-    os = require('os');
-    if (os.platform() === 'win32') {
-      return {
-        program: 'cmd.exe',
-        args: ['/s', '/c', command]
-      };
-    } else {
-      return {
-        program: '/bin/sh',
-        args: ['-c', command]
-      };
-    }
-  };
-
-  module.exports = {
-    signature: 'ssh [uuid]',
-    description: '(beta) get a shell into the running app container of a device',
-    help: 'WARNING: If you\'re running Windows, this command only supports `cmd.exe`.\n\nUse this command to get a shell into the running application container of\nyour device.\n\nExamples:\n\n	$ resin ssh MyApp\n	$ resin ssh 7cf02a6\n	$ resin ssh 7cf02a6 --port 8080\n	$ resin ssh 7cf02a6 -v',
-    permission: 'user',
-    primary: true,
-    options: [
-      {
-        signature: 'port',
-        parameter: 'port',
-        description: 'ssh gateway port',
-        alias: 'p'
-      }, {
-        signature: 'verbose',
-        boolean: true,
-        description: 'increase verbosity',
-        alias: 'v'
-      }
-    ],
-    action: function(params, options, done) {
-      var Promise, child_process, patterns, resin, settings, verbose;
-      child_process = require('child_process');
-      Promise = require('bluebird');
-      resin = require('resin-sdk');
-      settings = require('resin-settings-client');
-      patterns = require('../utils/patterns');
-      if (options.port == null) {
-        options.port = 22;
-      }
-      verbose = options.verbose ? '-vvv' : '';
-      return resin.models.device.has(params.uuid).then(function(isValidUUID) {
-        if (isValidUUID) {
-          return params.uuid;
-        }
-        return patterns.inferOrSelectDevice();
-      }).then(function(uuid) {
-        console.info("Connecting with: " + uuid);
-        return resin.models.device.get(uuid);
-      }).then(function(device) {
-        if (!device.is_online) {
-          throw new Error('Device is not online');
-        }
-        return Promise.props({
-          username: resin.auth.whoami(),
-          uuid: device.uuid,
-          containerId: resin.models.device.getApplicationInfo(device.uuid).get('containerId')
-        }).then(function(arg) {
-          var containerId, username, uuid;
-          username = arg.username, uuid = arg.uuid, containerId = arg.containerId;
-          if (containerId == null) {
-            throw new Error('Did not find running application container');
-          }
-          return Promise["try"](function() {
-            var command, spawn, subShellCommand;
-            command = "ssh " + verbose + " -t -o LogLevel=ERROR -o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null -o ControlMaster=no -p " + options.port + " " + username + "@ssh." + (settings.get('proxyUrl')) + " enter " + uuid + " " + containerId;
-            subShellCommand = getSubShellCommand(command);
-            return spawn = child_process.spawn(subShellCommand.program, subShellCommand.args, {
-              stdio: 'inherit'
-            });
-          });
-        });
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/sync.js

@@ -1,140 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var loadConfig;
-
-  loadConfig = function(source) {
-    var _, config, configPath, error, fs, jsYaml, path, result;
-    fs = require('fs');
-    path = require('path');
-    _ = require('lodash');
-    jsYaml = require('js-yaml');
-    configPath = path.join(source, '.resin-sync.yml');
-    try {
-      config = fs.readFileSync(configPath, {
-        encoding: 'utf8'
-      });
-      result = jsYaml.safeLoad(config);
-    } catch (error1) {
-      error = error1;
-      if (error.code === 'ENOENT') {
-        return {};
-      }
-      throw error;
-    }
-    if (!_.isPlainObject(result)) {
-      throw new Error("Invalid configuration file: " + configPath);
-    }
-    return result;
-  };
-
-  module.exports = {
-    signature: 'sync [uuid]',
-    description: '(beta) sync your changes to a device',
-    help: 'WARNING: If you\'re running Windows, this command only supports `cmd.exe`.\n\nUse this command to sync your local changes to a certain device on the fly.\n\nAfter every \'resin sync\' the updated settings will be saved in\n\'<source>/.resin-sync.yml\' and will be used in later invocations. You can\nalso change any option by editing \'.resin-sync.yml\' directly.\n\nHere is an example \'.resin-sync.yml\' :\n\n	$ cat $PWD/.resin-sync.yml\n	uuid: 7cf02a6\n	destination: \'/usr/src/app\'\n	before: \'echo Hello\'\n	after: \'echo Done\'\n	ignore:\n		- .git\n		- node_modules/\n\nCommand line options have precedence over the ones saved in \'.resin-sync.yml\'.\n\nIf \'.gitignore\' is found in the source directory then all explicitly listed files will be\nexcluded from the syncing process. You can choose to change this default behavior with the\n\'--skip-gitignore\' option.\n\nExamples:\n\n	$ resin sync 7cf02a6 --source . --destination /usr/src/app\n	$ resin sync 7cf02a6 -s /home/user/myResinProject -d /usr/src/app --before \'echo Hello\' --after \'echo Done\'\n	$ resin sync --ignore lib/\n	$ resin sync --verbose false\n	$ resin sync',
-    permission: 'user',
-    primary: true,
-    options: [
-      {
-        signature: 'source',
-        parameter: 'path',
-        description: 'local directory path to synchronize to device',
-        alias: 's'
-      }, {
-        signature: 'destination',
-        parameter: 'path',
-        description: 'destination path on device',
-        alias: 'd'
-      }, {
-        signature: 'ignore',
-        parameter: 'paths',
-        description: 'comma delimited paths to ignore when syncing',
-        alias: 'i'
-      }, {
-        signature: 'skip-gitignore',
-        boolean: true,
-        description: 'do not parse excluded/included files from .gitignore'
-      }, {
-        signature: 'before',
-        parameter: 'command',
-        description: 'execute a command before syncing',
-        alias: 'b'
-      }, {
-        signature: 'after',
-        parameter: 'command',
-        description: 'execute a command after syncing',
-        alias: 'a'
-      }, {
-        signature: 'port',
-        parameter: 'port',
-        description: 'ssh port',
-        alias: 't'
-      }, {
-        signature: 'progress',
-        boolean: true,
-        description: 'show progress',
-        alias: 'p'
-      }, {
-        signature: 'verbose',
-        boolean: true,
-        description: 'increase verbosity',
-        alias: 'v'
-      }
-    ],
-    action: function(params, options, done) {
-      var Promise, fs, path, patterns, resin, resinSync;
-      fs = require('fs');
-      path = require('path');
-      resin = require('resin-sdk');
-      Promise = require('bluebird');
-      resinSync = require('resin-sync');
-      patterns = require('../utils/patterns');
-      return Promise["try"](function() {
-        try {
-          fs.accessSync(path.join(process.cwd(), '.resin-sync.yml'));
-        } catch (error1) {
-          if (options.source == null) {
-            throw new Error('No --source option passed and no \'.resin-sync.yml\' file found in current directory.');
-          }
-        }
-        if (options.source == null) {
-          options.source = process.cwd();
-        }
-        if (options.ignore != null) {
-          options.ignore = options.ignore.split(',');
-        }
-        return Promise.resolve(params.uuid).then(function(uuid) {
-          var savedUuid;
-          if (uuid == null) {
-            savedUuid = loadConfig(options.source).uuid;
-            return patterns.inferOrSelectDevice(savedUuid);
-          }
-          return resin.models.device.has(uuid).then(function(hasDevice) {
-            if (!hasDevice) {
-              throw new Error("Device not found: " + uuid);
-            }
-            return uuid;
-          });
-        }).then(function(uuid) {
-          return resinSync.sync(uuid, options);
-        });
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/actions/wizard.js

@@ -1,63 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  exports.wizard = {
-    signature: 'quickstart [name]',
-    description: 'getting started with resin.io',
-    help: 'Use this command to run a friendly wizard to get started with resin.io.\n\nThe wizard will guide you through:\n\n	- Create an application.\n	- Initialise an SDCard with the resin.io operating system.\n	- Associate an existing project directory with your resin.io application.\n	- Push your project to your devices.\n\nExamples:\n\n	$ resin quickstart\n	$ resin quickstart MyApp',
-    primary: true,
-    action: function(params, options, done) {
-      var Promise, capitano, patterns, resin;
-      Promise = require('bluebird');
-      capitano = Promise.promisifyAll(require('capitano'));
-      resin = require('resin-sdk');
-      patterns = require('../utils/patterns');
-      return resin.auth.isLoggedIn().then(function(isLoggedIn) {
-        if (isLoggedIn) {
-          return;
-        }
-        console.info('Looks like you\'re not logged in yet!');
-        console.info('Lets go through a quick wizard to get you started.\n');
-        return capitano.runAsync('login');
-      }).then(function() {
-        if (params.name != null) {
-          return;
-        }
-        return patterns.selectOrCreateApplication().tap(function(applicationName) {
-          return resin.models.application.has(applicationName).then(function(hasApplication) {
-            if (hasApplication) {
-              return applicationName;
-            }
-            return capitano.runAsync("app create " + applicationName);
-          });
-        }).then(function(applicationName) {
-          return params.name = applicationName;
-        });
-      }).then(function() {
-        return capitano.runAsync("device init --application " + params.name);
-      }).tap(patterns.awaitDevice).then(function(uuid) {
-        return capitano.runAsync("device " + uuid);
-      }).then(function() {
-        return resin.models.application.get(params.name);
-      }).then(function(application) {
-        return console.log("Your device is ready to start pushing some code!\n\nCheck our official documentation for more information:\n\n    http://docs.resin.io/#/pages/introduction/introduction.md\n\nClone an example or go to an existing application directory and run:\n\n    $ git remote add resin " + application.git_repository + "\n    $ git push resin master");
-      }).nodeify(done);
-    }
-  };
-
-}).call(this);

build/app.js

@@ -1,174 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var Promise, _, actions, capitano, errors, events, plugins, resin, update;
-
-  _ = require('lodash');
-
-  Promise = require('bluebird');
-
-  capitano = Promise.promisifyAll(require('capitano'));
-
-  resin = require('resin-sdk');
-
-  actions = require('./actions');
-
-  errors = require('./errors');
-
-  events = require('./events');
-
-  plugins = require('./utils/plugins');
-
-  update = require('./utils/update');
-
-  capitano.permission('user', function(done) {
-    return resin.auth.isLoggedIn().then(function(isLoggedIn) {
-      if (!isLoggedIn) {
-        throw new Error('You have to log in to continue\n\nRun the following command to go through the login wizard:\n\n  $ resin login');
-      }
-    }).nodeify(done);
-  });
-
-  capitano.command({
-    signature: '*',
-    action: function() {
-      return capitano.execute({
-        command: 'help'
-      });
-    }
-  });
-
-  capitano.globalOption({
-    signature: 'help',
-    boolean: true,
-    alias: 'h'
-  });
-
-  capitano.command(actions.info.version);
-
-  capitano.command(actions.help.help);
-
-  capitano.command(actions.wizard.wizard);
-
-  capitano.command(actions.auth.login);
-
-  capitano.command(actions.auth.logout);
-
-  capitano.command(actions.auth.signup);
-
-  capitano.command(actions.auth.whoami);
-
-  capitano.command(actions.app.create);
-
-  capitano.command(actions.app.list);
-
-  capitano.command(actions.app.remove);
-
-  capitano.command(actions.app.restart);
-
-  capitano.command(actions.app.info);
-
-  capitano.command(actions.device.list);
-
-  capitano.command(actions.device.supported);
-
-  capitano.command(actions.device.rename);
-
-  capitano.command(actions.device.init);
-
-  capitano.command(actions.device.remove);
-
-  capitano.command(actions.device.identify);
-
-  capitano.command(actions.device.reboot);
-
-  capitano.command(actions.device.shutdown);
-
-  capitano.command(actions.device.enableDeviceUrl);
-
-  capitano.command(actions.device.disableDeviceUrl);
-
-  capitano.command(actions.device.getDeviceUrl);
-
-  capitano.command(actions.device.hasDeviceUrl);
-
-  capitano.command(actions.device.register);
-
-  capitano.command(actions.device.move);
-
-  capitano.command(actions.device.info);
-
-  capitano.command(actions.notes.set);
-
-  capitano.command(actions.keys.list);
-
-  capitano.command(actions.keys.add);
-
-  capitano.command(actions.keys.info);
-
-  capitano.command(actions.keys.remove);
-
-  capitano.command(actions.env.list);
-
-  capitano.command(actions.env.add);
-
-  capitano.command(actions.env.rename);
-
-  capitano.command(actions.env.remove);
-
-  capitano.command(actions.os.download);
-
-  capitano.command(actions.os.configure);
-
-  capitano.command(actions.os.initialize);
-
-  capitano.command(actions.config.read);
-
-  capitano.command(actions.config.write);
-
-  capitano.command(actions.config.inject);
-
-  capitano.command(actions.config.reconfigure);
-
-  capitano.command(actions.config.generate);
-
-  capitano.command(actions.settings.list);
-
-  capitano.command(actions.logs);
-
-  capitano.command(actions.sync);
-
-  capitano.command(actions.ssh);
-
-  update.notify();
-
-  plugins.register(/^resin-plugin-(.+)$/).then(function() {
-    var cli;
-    cli = capitano.parse(process.argv);
-    return events.trackCommand(cli).then(function() {
-      var ref, ref1;
-      if ((ref = cli.global) != null ? ref.help : void 0) {
-        return capitano.executeAsync({
-          command: "help " + ((ref1 = cli.command) != null ? ref1 : '')
-        });
-      }
-      return capitano.executeAsync(cli);
-    });
-  })["catch"](errors.handle);
-
-}).call(this);

build/errors.js

@@ -1,40 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var chalk, errors, patterns;
-
-  chalk = require('chalk');
-
-  errors = require('resin-cli-errors');
-
-  patterns = require('./utils/patterns');
-
-  exports.handle = function(error) {
-    var message;
-    message = errors.interpret(error);
-    if (message == null) {
-      return;
-    }
-    if (process.env.DEBUG) {
-      message = error.stack;
-    }
-    patterns.printErrorMessage(message);
-    return process.exit(error.exitCode || 1);
-  };
-
-}).call(this);

build/events.js

@@ -1,41 +0,0 @@
-(function() {
-  var Mixpanel, Promise, _, capitanoState, packageJSON, resin;
-
-  _ = require('lodash');
-
-  Mixpanel = require('mixpanel');
-
-  Promise = require('bluebird');
-
-  resin = require('resin-sdk');
-
-  capitanoState = Promise.promisifyAll(require('capitano').state);
-
-  packageJSON = require('../package.json');
-
-  exports.getLoggerInstance = _.memoize(function() {
-    return resin.models.config.getMixpanelToken().then(Mixpanel.init);
-  });
-
-  exports.trackCommand = function(capitanoCommand) {
-    return Promise.props({
-      resinUrl: resin.settings.get('resinUrl'),
-      username: resin.auth.whoami(),
-      mixpanel: exports.getLoggerInstance()
-    }).then(function(data) {
-      return capitanoState.getMatchCommandAsync(capitanoCommand.command).then(function(command) {
-        return data.mixpanel.track("[CLI] " + (command.signature.toString()), {
-          distinct_id: data.username,
-          argv: process.argv.join(' '),
-          version: packageJSON.version,
-          node: process.version,
-          arch: process.arch,
-          resinUrl: data.resinUrl,
-          platform: process.platform,
-          command: capitanoCommand
-        });
-      });
-    });
-  };
-
-}).call(this);

build/utils/helpers.js

@@ -1,84 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var Promise, _, capitano, chalk, imagefs, os, president, resin, rindle;
-
-  Promise = require('bluebird');
-
-  capitano = Promise.promisifyAll(require('capitano'));
-
-  _ = require('lodash');
-
-  _.str = require('underscore.string');
-
-  president = Promise.promisifyAll(require('president'));
-
-  resin = require('resin-sdk');
-
-  imagefs = require('resin-image-fs');
-
-  rindle = require('rindle');
-
-  os = require('os');
-
-  chalk = require('chalk');
-
-  exports.getGroupDefaults = function(group) {
-    return _.chain(group).get('options').map(function(question) {
-      return [question.name, question["default"]];
-    }).object().value();
-  };
-
-  exports.stateToString = function(state) {
-    var percentage, result;
-    percentage = _.str.lpad(state.percentage, 3, '0') + '%';
-    result = (chalk.blue(percentage)) + " " + (chalk.cyan(state.operation.command));
-    switch (state.operation.command) {
-      case 'copy':
-        return result + " " + state.operation.from.path + " -> " + state.operation.to.path;
-      case 'replace':
-        return result + " " + state.operation.file.path + ", " + state.operation.copy + " -> " + state.operation.replace;
-      case 'run-script':
-        return result + " " + state.operation.script;
-      default:
-        throw new Error("Unsupported operation: " + state.operation.type);
-    }
-  };
-
-  exports.sudo = function(command, message) {
-    command = _.union(_.take(process.argv, 2), command);
-    console.log(message);
-    if (os.platform() !== 'win32') {
-      console.log('Type your computer password to continue');
-    }
-    return president.executeAsync(command);
-  };
-
-  exports.getManifest = function(image, deviceType) {
-    return imagefs.read({
-      image: image,
-      partition: {
-        primary: 1
-      },
-      path: '/device-type.json'
-    }).then(rindle.extractAsync).then(JSON.parse)["catch"](function() {
-      return resin.models.device.getManifestBySlug(deviceType);
-    });
-  };
-
-}).call(this);

build/utils/messages.js

@@ -1,10 +0,0 @@
-(function() {
-  exports.gettingStarted = 'Run the following command to get a device started with Resin.io\n\n  $ resin quickstart';
-
-  exports.reachingOut = 'If you need help, or just want to say hi, don\'t hesitate in reaching out at:\n\n  GitHub: https://github.com/resin-io/resin-cli/issues/new\n  Gitter: https://gitter.im/resin-io/chat';
-
-  exports.getHelp = 'If you need help, don\'t hesitate in contacting us at:\n\n  GitHub: https://github.com/resin-io/resin-cli/issues/new\n  Gitter: https://gitter.im/resin-io/chat';
-
-  exports.resinAsciiArt = '______          _         _\n| ___ \\        (_)       (_)\n| |_/ /___  ___ _ _ __    _  ___\n|    // _ \\/ __| | \'_ \\  | |/ _ \\\n| |\\ \\  __/\\__ \\ | | | |_| | (_) |\n\\_| \\_\\___||___/_|_| |_(_)_|\\___/';
-
-}).call(this);

build/utils/patterns.js

@@ -1,221 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var Promise, _, chalk, form, messages, resin, validation, visuals,
-    indexOf = [].indexOf || function(item) { for (var i = 0, l = this.length; i < l; i++) { if (i in this && this[i] === item) return i; } return -1; };
-
-  _ = require('lodash');
-
-  Promise = require('bluebird');
-
-  form = require('resin-cli-form');
-
-  visuals = require('resin-cli-visuals');
-
-  resin = require('resin-sdk');
-
-  chalk = require('chalk');
-
-  validation = require('./validation');
-
-  messages = require('./messages');
-
-  exports.authenticate = function(options) {
-    return form.run([
-      {
-        message: 'Email:',
-        name: 'email',
-        type: 'input',
-        validate: validation.validateEmail
-      }, {
-        message: 'Password:',
-        name: 'password',
-        type: 'password'
-      }
-    ], {
-      override: options
-    }).then(resin.auth.login).then(resin.auth.twoFactor.isPassed).then(function(isTwoFactorAuthPassed) {
-      if (isTwoFactorAuthPassed) {
-        return;
-      }
-      return form.ask({
-        message: 'Two factor auth challenge:',
-        name: 'code',
-        type: 'input'
-      }).then(resin.auth.twoFactor.challenge)["catch"](function(error) {
-        return resin.auth.logout().then(function() {
-          if (error.name === 'ResinRequestError' && error.statusCode === 401) {
-            throw new Error('Invalid two factor authentication code');
-          }
-          throw error;
-        });
-      });
-    });
-  };
-
-  exports.askLoginType = function() {
-    return form.ask({
-      message: 'How would you like to login?',
-      name: 'loginType',
-      type: 'list',
-      choices: [
-        {
-          name: 'Web authorization (recommended)',
-          value: 'web'
-        }, {
-          name: 'Credentials',
-          value: 'credentials'
-        }, {
-          name: 'Authentication token',
-          value: 'token'
-        }, {
-          name: 'I don\'t have a Resin account!',
-          value: 'register'
-        }
-      ]
-    });
-  };
-
-  exports.selectDeviceType = function() {
-    return resin.models.device.getSupportedDeviceTypes().then(function(deviceTypes) {
-      return form.ask({
-        message: 'Device Type',
-        type: 'list',
-        choices: deviceTypes
-      });
-    });
-  };
-
-  exports.confirm = function(yesOption, message) {
-    return Promise["try"](function() {
-      if (yesOption) {
-        return true;
-      }
-      return form.ask({
-        message: message,
-        type: 'confirm',
-        "default": false
-      });
-    }).then(function(confirmed) {
-      if (!confirmed) {
-        throw new Error('Aborted');
-      }
-    });
-  };
-
-  exports.selectApplication = function(filter) {
-    return resin.models.application.hasAny().then(function(hasAnyApplications) {
-      if (!hasAnyApplications) {
-        throw new Error('You don\'t have any applications');
-      }
-      return resin.models.application.getAll();
-    }).filter(filter || _.constant(true)).then(function(applications) {
-      return form.ask({
-        message: 'Select an application',
-        type: 'list',
-        choices: _.map(applications, function(application) {
-          return {
-            name: application.app_name + " (" + application.device_type + ")",
-            value: application.app_name
-          };
-        })
-      });
-    });
-  };
-
-  exports.selectOrCreateApplication = function() {
-    return resin.models.application.hasAny().then(function(hasAnyApplications) {
-      if (!hasAnyApplications) {
-        return;
-      }
-      return resin.models.application.getAll().then(function(applications) {
-        applications = _.map(applications, function(application) {
-          return {
-            name: application.app_name + " (" + application.device_type + ")",
-            value: application.app_name
-          };
-        });
-        applications.unshift({
-          name: 'Create a new application',
-          value: null
-        });
-        return form.ask({
-          message: 'Select an application',
-          type: 'list',
-          choices: applications
-        });
-      });
-    }).then(function(application) {
-      if (application != null) {
-        return application;
-      }
-      return form.ask({
-        message: 'Choose a Name for your new application',
-        type: 'input',
-        validate: validation.validateApplicationName
-      });
-    });
-  };
-
-  exports.awaitDevice = function(uuid) {
-    return resin.models.device.getName(uuid).then(function(deviceName) {
-      var poll, spinner;
-      spinner = new visuals.Spinner("Waiting for " + deviceName + " to come online");
-      poll = function() {
-        return resin.models.device.isOnline(uuid).then(function(isOnline) {
-          if (isOnline) {
-            spinner.stop();
-            console.info("The device **" + deviceName + "** is online!");
-          } else {
-            spinner.start();
-            return Promise.delay(3000).then(poll);
-          }
-        });
-      };
-      console.info("Waiting for " + deviceName + " to connect to resin...");
-      return poll()["return"](uuid);
-    });
-  };
-
-  exports.inferOrSelectDevice = function(preferredUuid) {
-    return resin.models.device.getAll().filter(function(device) {
-      return device.is_online;
-    }).then(function(onlineDevices) {
-      if (_.isEmpty(onlineDevices)) {
-        throw new Error('You don\'t have any devices online');
-      }
-      return form.ask({
-        message: 'Select a device',
-        type: 'list',
-        "default": indexOf.call(_.map(onlineDevices, 'uuid'), preferredUuid) >= 0 ? preferredUuid : onlineDevices[0].uuid,
-        choices: _.map(onlineDevices, function(device) {
-          return {
-            name: (device.name || 'Untitled') + " (" + (device.uuid.slice(0, 7)) + ")",
-            value: device.uuid
-          };
-        })
-      });
-    });
-  };
-
-  exports.printErrorMessage = function(message) {
-    console.error(chalk.red(message));
-    return console.error(chalk.red("\n" + messages.getHelp + "\n"));
-  };
-
-}).call(this);

build/utils/plugins.js

@@ -1,43 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var _, capitano, nplugm, patterns;
-
-  nplugm = require('nplugm');
-
-  _ = require('lodash');
-
-  capitano = require('capitano');
-
-  patterns = require('./patterns');
-
-  exports.register = function(regex) {
-    return nplugm.list(regex).map(function(plugin) {
-      var command;
-      command = require(plugin);
-      command.plugin = true;
-      if (!_.isArray(command)) {
-        return capitano.command(command);
-      }
-      return _.each(command, capitano.command);
-    })["catch"](function(error) {
-      return patterns.printErrorMessage(error.message);
-    });
-  };
-
-}).call(this);

build/utils/update.js

@@ -1,50 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var isRoot, notifier, packageJSON, updateNotifier;
-
-  updateNotifier = require('update-notifier');
-
-  isRoot = require('is-root');
-
-  packageJSON = require('../../package.json');
-
-  if (!isRoot()) {
-    notifier = updateNotifier({
-      pkg: packageJSON,
-      updateCheckInterval: 0
-    });
-  }
-
-  exports.hasAvailableUpdate = function() {
-    return notifier != null;
-  };
-
-  exports.notify = function() {
-    if (!exports.hasAvailableUpdate()) {
-      return;
-    }
-    notifier.notify({
-      defer: false
-    });
-    if (notifier.update != null) {
-      return console.log('Notice that you might need administrator privileges depending on your setup\n');
-    }
-  };
-
-}).call(this);

build/utils/validation.js

@@ -1,44 +0,0 @@
-
-/*
-Copyright 2016 Resin.io
-
-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.
- */
-
-(function() {
-  var validEmail;
-
-  validEmail = require('valid-email');
-
-  exports.validateEmail = function(input) {
-    if (!validEmail(input)) {
-      return 'Email is not valid';
-    }
-    return true;
-  };
-
-  exports.validatePassword = function(input) {
-    if (input.length < 8) {
-      return 'Password should be 8 characters long';
-    }
-    return true;
-  };
-
-  exports.validateApplicationName = function(input) {
-    if (input.length < 4) {
-      return 'The application name should be at least 4 characters';
-    }
-    return true;
-  };
-
-}).call(this);

capitanodoc.json

@@ -1,96 +0,0 @@
-{
-	"title": "Resin CLI Documentation",
-	"introduction": "This tool allows you to interact with the resin.io api from the comfort of your command line.\n\nTo get started download the CLI from npm.\n\n\t$ npm install resin-cli -g\n\nThen authenticate yourself:\n\n\t$ resin login\n\nNow you have access to all the commands referenced below.",
-	"categories": [
-		{
-			"title": "Application",
-			"files": [
-				"lib/actions/app.coffee"
-			]
-		},
-		{
-			"title": "Authentication",
-			"files": [
-				"lib/actions/auth.coffee"
-			]
-		},
-		{
-			"title": "Device",
-			"files": [
-				"lib/actions/device.coffee"
-			]
-		},
-		{
-			"title": "Environment Variables",
-			"files": [
-				"lib/actions/environment-variables.coffee"
-			]
-		},
-		{
-			"title": "Help",
-			"files": [
-				"lib/actions/help.coffee"
-			]
-		},
-		{
-			"title": "Information",
-			"files": [
-				"lib/actions/info.coffee"
-			]
-		},
-		{
-			"title": "Keys",
-			"files": [
-				"lib/actions/keys.coffee"
-			]
-		},
-		{
-			"title": "Logs",
-			"files": [
-				"lib/actions/logs.coffee"
-			]
-		},
-		{
-			"title": "Sync",
-			"files": [
-				"lib/actions/sync.coffee"
-			]
-		},
-		{
-			"title": "SSH",
-			"files": [
-				"lib/actions/ssh.coffee"
-			]
-		},
-		{
-			"title": "Notes",
-			"files": [
-				"lib/actions/notes.coffee"
-			]
-		},
-		{
-			"title": "OS",
-			"files": [
-				"lib/actions/os.coffee"
-			]
-		},
-		{
-			"title": "Config",
-			"files": [
-				"lib/actions/config.coffee"
-			]
-		},
-		{
-			"title": "Settings",
-			"files": [
-				"lib/actions/settings.coffee"
-			]
-		},
-		{
-			"title": "Wizard",
-			"files": [
-				"lib/actions/wizard.coffee"
-			]
-		}
-	]
-}

coffeelint.json

@@ -1,127 +0,0 @@
-{
-    "coffeescript_error": {
-        "level": "error"
-    },
-    "arrow_spacing": {
-        "name": "arrow_spacing",
-        "level": "error"
-    },
-    "no_tabs": {
-        "name": "no_tabs",
-        "level": "ignore"
-    },
-    "no_trailing_whitespace": {
-        "name": "no_trailing_whitespace",
-        "level": "error",
-        "allowed_in_comments": false,
-        "allowed_in_empty_lines": false
-    },
-    "max_line_length": {
-        "name": "max_line_length",
-        "value": 120,
-        "level": "error",
-        "limitComments": true
-    },
-    "line_endings": {
-        "name": "line_endings",
-        "level": "ignore",
-        "value": "unix"
-    },
-    "no_trailing_semicolons": {
-        "name": "no_trailing_semicolons",
-        "level": "error"
-    },
-    "indentation": {
-        "name": "indentation",
-        "value": 1,
-        "level": "error"
-    },
-    "camel_case_classes": {
-        "name": "camel_case_classes",
-        "level": "error"
-    },
-    "colon_assignment_spacing": {
-        "name": "colon_assignment_spacing",
-        "level": "error",
-        "spacing": {
-            "left": 0,
-            "right": 1
-        }
-    },
-    "no_implicit_braces": {
-        "name": "no_implicit_braces",
-        "level": "ignore",
-        "strict": false
-    },
-    "no_plusplus": {
-        "name": "no_plusplus",
-        "level": "ignore"
-    },
-    "no_throwing_strings": {
-        "name": "no_throwing_strings",
-        "level": "error"
-    },
-    "no_backticks": {
-        "name": "no_backticks",
-        "level": "error"
-    },
-    "no_implicit_parens": {
-        "name": "no_implicit_parens",
-        "strict": false,
-        "level": "ignore"
-    },
-    "no_empty_param_list": {
-        "name": "no_empty_param_list",
-        "level": "error"
-    },
-    "no_stand_alone_at": {
-        "name": "no_stand_alone_at",
-        "level": "ignore"
-    },
-    "space_operators": {
-        "name": "space_operators",
-        "level": "error"
-    },
-    "duplicate_key": {
-        "name": "duplicate_key",
-        "level": "error"
-    },
-    "empty_constructor_needs_parens": {
-        "name": "empty_constructor_needs_parens",
-        "level": "ignore"
-    },
-    "cyclomatic_complexity": {
-        "name": "cyclomatic_complexity",
-        "value": 10,
-        "level": "ignore"
-    },
-    "newlines_after_classes": {
-        "name": "newlines_after_classes",
-        "value": 3,
-        "level": "ignore"
-    },
-    "no_unnecessary_fat_arrows": {
-        "name": "no_unnecessary_fat_arrows",
-        "level": "error"
-    },
-    "missing_fat_arrows": {
-        "name": "missing_fat_arrows",
-        "level": "ignore"
-    },
-    "non_empty_constructor_needs_parens": {
-        "name": "non_empty_constructor_needs_parens",
-        "level": "ignore"
-    },
-    "no_unnecessary_double_quotes": {
-        "name": "no_unnecessary_double_quotes",
-        "level": "error"
-    },
-    "no_debugger": {
-        "name": "no_debugger",
-        "level": "warn"
-    },
-    "no_interpolation_in_single_quotes": {
-        "name": "no_interpolation_in_single_quotes",
-        "level": "error"
-    }
-}

doc/automated-init.md

@@ -0,0 +1,112 @@
+# Provisioning balena devices in automated (non-interactive) mode
+
+This document describes how to run the `device init` command in non-interactive mode.
+
+It requires collecting some preliminary information _once_.
+
+The final command to provision the device looks like this:
+
+```bash
+balena device init --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.

extras/capitanodoc/index.coffee

@@ -1,46 +0,0 @@
-_ = require('lodash')
-path = require('path')
-capitanodoc = require('../../capitanodoc.json')
-markdown = require('./markdown')
-
-result = {}
-result.title = capitanodoc.title
-result.introduction = capitanodoc.introduction
-result.categories = []
-
-for commandCategory in capitanodoc.categories
-	category = {}
-	category.title = commandCategory.title
-	category.commands = []
-
-	for file in commandCategory.files
-		actions = require(path.join(process.cwd(), file))
-
-		if actions.signature?
-			category.commands.push(_.omit(actions, 'action'))
-		else
-			for actionName, actionCommand of actions
-				category.commands.push(_.omit(actionCommand, 'action'))
-
-	result.categories.push(category)
-
-result.toc = _.cloneDeep(result.categories)
-result.toc = _.map result.toc, (category) ->
-	category.commands = _.map category.commands, (command) ->
-		return {
-			signature: command.signature
-			anchor: '#' + command.signature
-								.replace(/\s/g,'-')
-								.replace(/</g, '60-')
-								.replace(/>/g, '-62-')
-								.replace(/\[/g, '')
-								.replace(/\]/g, '-')
-								.replace(/--/g, '-')
-								.replace(/\.\.\./g, '')
-								.replace(/\|/g, '')
-								.toLowerCase()
-		}
-
-	return category
-
-console.log(markdown.display(result))

extras/capitanodoc/markdown.coffee

@@ -1,66 +0,0 @@
-_ = require('lodash')
-ent = require('ent')
-utils = require('./utils')
-
-exports.command = (command) ->
-	result = """
-		## #{ent.encode(command.signature)}
-
-		#{command.help}\n
-	"""
-
-	if not _.isEmpty(command.options)
-		result += '\n### Options'
-
-		for option in command.options
-			result += """
-				\n\n#### #{utils.parseSignature(option)}
-
-				#{option.description}
-			"""
-
-		result += '\n'
-
-	return result
-
-exports.category = (category) ->
-	result = """
-		# #{category.title}\n
-	"""
-
-	for command in category.commands
-		result += '\n' + exports.command(command)
-
-	return result
-
-exports.toc = (toc) ->
-	result = '''
-		# Table of contents\n
-	'''
-
-	for category in toc
-
-		result += """
-			\n- #{category.title}\n\n
-		"""
-
-		for command in category.commands
-			result += """
-				\t- [#{ent.encode(command.signature)}](#{command.anchor})\n
-			"""
-
-	return result
-
-exports.display = (doc) ->
-	result = """
-		# #{doc.title}
-
-		#{doc.introduction}
-
-		#{exports.toc(doc.toc)}
-	"""
-
-	for category in doc.categories
-		result += '\n' + exports.category(category)
-
-	return result

extras/capitanodoc/utils.coffee

@@ -1,26 +0,0 @@
-_ = require('lodash')
-ent = require('ent')
-
-exports.getOptionPrefix = (signature) ->
-	if signature.length > 1
-		return '--'
-	else
-		return '-'
-
-exports.getOptionSignature = (signature) ->
-	return "#{exports.getOptionPrefix(signature)}#{signature}"
-
-exports.parseSignature = (option) ->
-	result = exports.getOptionSignature(option.signature)
-
-	if not _.isEmpty(option.alias)
-		if _.isString(option.alias)
-			result += ", #{exports.getOptionSignature(option.alias)}"
-		else
-			for alias in option.alias
-				result += ", #{exports.getOptionSignature(option.alias)}"
-
-	if option.parameter?
-		result += " <#{option.parameter}>"
-
-	return ent.encode(result)

gulpfile.coffee

@@ -1,34 +0,0 @@
-path = require('path')
-gulp = require('gulp')
-coffee = require('gulp-coffee')
-coffeelint = require('gulp-coffeelint')
-shell = require('gulp-shell')
-packageJSON = require('./package.json')
-
-OPTIONS =
-	config:
-		coffeelint: path.join(__dirname, 'coffeelint.json')
-	files:
-		coffee: [ 'lib/**/*.coffee', 'gulpfile.coffee' ]
-		app: [ 'lib/**/*.coffee', '!lib/**/*.spec.coffee' ]
-	directories:
-		build: 'build/'
-
-gulp.task 'coffee', [ 'lint' ], ->
-	gulp.src(OPTIONS.files.app)
-		.pipe(coffee())
-		.pipe(gulp.dest(OPTIONS.directories.build))
-
-gulp.task 'lint', ->
-	gulp.src(OPTIONS.files.coffee)
-		.pipe(coffeelint({
-			optFile: OPTIONS.config.coffeelint
-		}))
-		.pipe(coffeelint.reporter())
-
-gulp.task 'build', [
-	'coffee'
-]
-
-gulp.task 'watch', [ 'lint', 'coffee' ], ->
-	gulp.watch([ OPTIONS.files.coffee ], [ 'coffee' ])

gulpfile.js

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

lib/actions/app.coffee

@@ -1,158 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-commandOptions = require('./command-options')
-
-exports.create =
-	signature: 'app create <name>'
-	description: 'create an application'
-	help: '''
-		Use this command to create a new resin.io application.
-
-		You can specify the application 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
-
-			$ resin devices supported
-
-		Examples:
-
-			$ resin app create MyApp
-			$ resin app create MyApp --type raspberry-pi
-	'''
-	options: [
-		{
-			signature: 'type'
-			parameter: 'type'
-			description: 'application type'
-			alias: 't'
-		}
-	]
-	permission: 'user'
-	primary: true
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		patterns = require('../utils/patterns')
-
-		# Validate the the application name is available
-		# before asking the device type.
-		# https://github.com/resin-io/resin-cli/issues/30
-		resin.models.application.has(params.name).then (hasApplication) ->
-			if hasApplication
-				throw new Error('You already have an application with that name!')
-
-		.then ->
-			return options.type or patterns.selectDeviceType()
-		.then (deviceType) ->
-			return resin.models.application.create(params.name, deviceType)
-		.then (application) ->
-			console.info("Application created: #{application.app_name} (#{application.device_type}, id #{application.id})")
-		.nodeify(done)
-
-exports.list =
-	signature: 'apps'
-	description: 'list all applications'
-	help: '''
-		Use this command to list all your applications.
-
-		Notice this command only shows the most important bits of information for each app.
-		If you want detailed information, use resin app <name> instead.
-
-		Examples:
-
-			$ resin apps
-	'''
-	permission: 'user'
-	primary: true
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		visuals = require('resin-cli-visuals')
-
-		resin.models.application.getAll().then (applications) ->
-			console.log visuals.table.horizontal applications, [
-				'id'
-				'app_name'
-				'device_type'
-				'online_devices'
-				'devices_length'
-			]
-		.nodeify(done)
-
-exports.info =
-	signature: 'app <name>'
-	description: 'list a single application'
-	help: '''
-		Use this command to show detailed information for a single application.
-
-		Examples:
-
-			$ resin app MyApp
-	'''
-	permission: 'user'
-	primary: true
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		visuals = require('resin-cli-visuals')
-
-		resin.models.application.get(params.name).then (application) ->
-			console.log visuals.table.vertical application, [
-				"$#{application.app_name}$"
-				'id'
-				'device_type'
-				'git_repository'
-				'commit'
-			]
-		.nodeify(done)
-
-exports.restart =
-	signature: 'app restart <name>'
-	description: 'restart an application'
-	help: '''
-		Use this command to restart all devices that belongs to a certain application.
-
-		Examples:
-
-			$ resin app restart MyApp
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.models.application.restart(params.name).nodeify(done)
-
-exports.remove =
-	signature: 'app rm <name>'
-	description: 'remove an application'
-	help: '''
-		Use this command to remove a resin.io application.
-
-		Notice this command asks for confirmation interactively.
-		You can avoid this by passing the `--yes` boolean option.
-
-		Examples:
-
-			$ resin app rm MyApp
-			$ resin app rm MyApp --yes
-	'''
-	options: [ commandOptions.yes ]
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		patterns = require('../utils/patterns')
-
-		patterns.confirm(options.yes, 'Are you sure you want to delete the application?').then ->
-			resin.models.application.remove(params.name)
-		.nodeify(done)

lib/actions/auth.coffee

@@ -1,215 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-exports.login	=
-	signature: 'login'
-	description: 'login to resin.io'
-	help: '''
-		Use this command to login to your resin.io account.
-
-		This command will prompt you to login using the following login types:
-
-		- Web authorization: open your web browser and prompt you to authorize the CLI
-		from the dashboard.
-
-		- Credentials: using email/password and 2FA.
-
-		- Token: using the authentication token from the preferences page.
-
-		Examples:
-
-			$ resin login
-			$ resin login --web
-			$ resin login --token "..."
-			$ resin login --credentials
-			$ resin login --credentials --email johndoe@gmail.com --password secret
-	'''
-	options: [
-		{
-			signature: 'token'
-			description: 'auth token'
-			parameter: 'token'
-			alias: 't'
-		}
-		{
-			signature: 'web'
-			description: 'web-based login'
-			boolean: true
-			alias: 'w'
-		}
-		{
-			signature: 'credentials'
-			description: 'credential-based login'
-			boolean: true
-			alias: 'c'
-		}
-		{
- 			signature: 'email'
- 			parameter: 'email'
- 			description: 'email'
- 			alias: [ 'e', 'u' ]
- 		}
- 		{
- 			signature: 'password'
- 			parameter: 'password'
- 			description: 'password'
- 			alias: 'p'
- 		}
-	]
-	primary: true
-	action: (params, options, done) ->
-		_ = require('lodash')
-		Promise = require('bluebird')
-		capitano = Promise.promisifyAll(require('capitano'))
-		resin = require('resin-sdk')
-		auth = require('resin-cli-auth')
-		form = require('resin-cli-form')
-		patterns = require('../utils/patterns')
-		messages = require('../utils/messages')
-
-		login = (options) ->
-			if options.token?
-				return Promise.try ->
-					return options.token if _.isString(options.token)
-					return form.ask
-						message: 'Token (from the preferences page)'
-						name: 'token'
-						type: 'input'
-				.then(resin.auth.loginWithToken)
-			else if options.credentials
-				return patterns.authenticate(options)
-			else if options.web
-				console.info('Connecting to the web dashboard')
-				return auth.login()
-
-			return patterns.askLoginType().then (loginType) ->
-
-				if loginType is 'register'
-					return capitano.runAsync('signup')
-
-				options[loginType] = true
-				return login(options)
-
-		resin.settings.get('resinUrl').then (resinUrl) ->
-			console.log(messages.resinAsciiArt)
-			console.log("\nLogging in to #{resinUrl}")
-			return login(options)
-		.then(resin.auth.whoami)
-		.tap (username) ->
-			console.info("Successfully logged in as: #{username}")
-			console.info """
-
-				Now what?
-
-				#{messages.gettingStarted}
-
-				Find out about more super powers by running:
-
-				  $ resin help
-
-				#{messages.reachingOut}
-			"""
-		.nodeify(done)
-
-exports.logout =
-	signature: 'logout'
-	description: 'logout from resin.io'
-	help: '''
-		Use this command to logout from your resin.io account.o
-
-		Examples:
-
-			$ resin logout
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.auth.logout().nodeify(done)
-
-exports.signup =
-	signature: 'signup'
-	description: 'signup to resin.io'
-	help: '''
-		Use this command to signup for a resin.io account.
-
-		If signup is successful, you'll be logged in to your new user automatically.
-
-		Examples:
-
-			$ resin signup
-			Email: me@mycompany.com
-			Username: johndoe
-			Password: ***********
-
-			$ resin whoami
-			johndoe
-	'''
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		form = require('resin-cli-form')
-		validation = require('../utils/validation')
-
-		resin.settings.get('resinUrl').then (resinUrl) ->
-			console.log("\nRegistering to #{resinUrl}")
-
-			form.run [
-				message: 'Email:'
-				name: 'email'
-				type: 'input'
-				validate: validation.validateEmail
-			,
-				message: 'Username:'
-				name: 'username'
-				type: 'input'
-			,
-				message: 'Password:'
-				name: 'password'
-				type: 'password',
-				validate: validation.validatePassword
-			]
-
-		.then(resin.auth.register)
-		.then(resin.auth.loginWithToken)
-		.nodeify(done)
-
-exports.whoami =
-	signature: 'whoami'
-	description: 'get current username and email address'
-	help: '''
-		Use this command to find out the current logged in username and email address.
-
-		Examples:
-
-			$ resin whoami
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		resin = require('resin-sdk')
-		visuals = require('resin-cli-visuals')
-
-		Promise.props
-			username: resin.auth.whoami()
-			email: resin.auth.getEmail()
-			url: resin.settings.get('resinUrl')
-		.then (results) ->
-			console.log visuals.table.vertical results, [
-				'$account information$'
-				'username'
-				'email'
-				'url'
-			]
-		.nodeify(done)

lib/actions/command-options.coffee

@@ -1,69 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-_ = require('lodash')
-
-exports.yes =
-	signature: 'yes'
-	description: 'confirm non interactively'
-	boolean: true
-	alias: 'y'
-
-exports.optionalApplication =
-	signature: 'application'
-	parameter: 'application'
-	description: 'application name'
-	alias: [ 'a', 'app' ]
-
-exports.application = _.defaults
-	required: 'You have to specify an application'
-, exports.optionalApplication
-
-exports.optionalDevice =
-	signature: 'device'
-	parameter: 'device'
-	description: 'device uuid'
-	alias: 'd'
-
-exports.booleanDevice =
-	signature: 'device'
-	description: 'device'
-	boolean: true
-	alias: 'd'
-
-exports.network =
-	signature: 'network'
-	parameter: 'network'
-	description: 'network type'
-	alias: 'n'
-
-exports.wifiSsid =
-	signature: 'ssid'
-	parameter: 'ssid'
-	description: 'wifi ssid, if network is wifi'
-	alias: 's'
-
-exports.wifiKey =
-	signature: 'key'
-	parameter: 'key'
-	description: 'wifi key, if network is wifi'
-	alias: 'k'
-
-exports.forceUpdateLock =
-	signature: 'force'
-	description: 'force action if the update lock is set'
-	boolean: true
-	alias: 'f'

lib/actions/config.coffee

@@ -1,277 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-commandOptions = require('./command-options')
-
-exports.read =
-	signature: 'config read'
-	description: 'read a device configuration'
-	help: '''
-		Use this command to read the config.json file from the mounted filesystem (e.g. SD card) of a provisioned device"
-
-		Examples:
-
-			$ resin config read --type raspberry-pi
-			$ resin config read --type raspberry-pi --drive /dev/disk2
-	'''
-	options: [
-		{
-			signature: 'type'
-			description: 'device type'
-			parameter: 'type'
-			alias: 't'
-			required: 'You have to specify a device type'
-		}
-		{
-			signature: 'drive'
-			description: 'drive'
-			parameter: 'drive'
-			alias: 'd'
-		}
-	]
-	permission: 'user'
-	root: true
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		config = require('resin-config-json')
-		visuals = require('resin-cli-visuals')
-		umount = Promise.promisifyAll(require('umount'))
-		prettyjson = require('prettyjson')
-
-		Promise.try ->
-			return options.drive or visuals.drive('Select the device drive')
-		.tap(umount.umountAsync)
-		.then (drive) ->
-			return config.read(drive, options.type)
-		.tap (configJSON) ->
-			console.info(prettyjson.render(configJSON))
-		.nodeify(done)
-
-exports.write =
-	signature: 'config write <key> <value>'
-	description: 'write a device configuration'
-	help: '''
-		Use this command to write the config.json file to the mounted filesystem (e.g. SD card) of a provisioned device
-
-		Examples:
-
-			$ resin config write --type raspberry-pi username johndoe
-			$ resin config write --type raspberry-pi --drive /dev/disk2 username johndoe
-			$ resin config write --type raspberry-pi files.network/settings "..."
-	'''
-	options: [
-		{
-			signature: 'type'
-			description: 'device type'
-			parameter: 'type'
-			alias: 't'
-			required: 'You have to specify a device type'
-		}
-		{
-			signature: 'drive'
-			description: 'drive'
-			parameter: 'drive'
-			alias: 'd'
-		}
-	]
-	permission: 'user'
-	root: true
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		_ = require('lodash')
-		config = require('resin-config-json')
-		visuals = require('resin-cli-visuals')
-		umount = Promise.promisifyAll(require('umount'))
-
-		Promise.try ->
-			return options.drive or visuals.drive('Select the device drive')
-		.tap(umount.umountAsync)
-		.then (drive) ->
-			config.read(drive, options.type).then (configJSON) ->
-				console.info("Setting #{params.key} to #{params.value}")
-				_.set(configJSON, params.key, params.value)
-				return configJSON
-			.tap ->
-				return umount.umountAsync(drive)
-			.then (configJSON) ->
-				return config.write(drive, options.type, configJSON)
-		.tap ->
-			console.info('Done')
-		.nodeify(done)
-
-exports.inject =
-	signature: 'config inject <file>'
-	description: 'inject a device configuration file'
-	help: '''
-		Use this command to inject a config.json file to the mounted filesystem (e.g. SD card) of a provisioned device"
-
-		Examples:
-
-			$ resin config inject my/config.json --type raspberry-pi
-			$ resin config inject my/config.json --type raspberry-pi --drive /dev/disk2
-	'''
-	options: [
-		{
-			signature: 'type'
-			description: 'device type'
-			parameter: 'type'
-			alias: 't'
-			required: 'You have to specify a device type'
-		}
-		{
-			signature: 'drive'
-			description: 'drive'
-			parameter: 'drive'
-			alias: 'd'
-		}
-	]
-	permission: 'user'
-	root: true
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		config = require('resin-config-json')
-		visuals = require('resin-cli-visuals')
-		umount = Promise.promisifyAll(require('umount'))
-		fs = Promise.promisifyAll(require('fs'))
-
-		Promise.try ->
-			return options.drive or visuals.drive('Select the device drive')
-		.tap(umount.umountAsync)
-		.then (drive) ->
-			fs.readFileAsync(params.file, 'utf8').then(JSON.parse).then (configJSON) ->
-				return config.write(drive, options.type, configJSON)
-		.tap ->
-			console.info('Done')
-		.nodeify(done)
-
-exports.reconfigure =
-	signature: 'config reconfigure'
-	description: 'reconfigure a provisioned device'
-	help: '''
-		Use this command to reconfigure a provisioned device
-
-		Examples:
-
-			$ resin config reconfigure --type raspberry-pi
-			$ resin config reconfigure --type raspberry-pi --advanced
-			$ resin config reconfigure --type raspberry-pi --drive /dev/disk2
-	'''
-	options: [
-		{
-			signature: 'type'
-			description: 'device type'
-			parameter: 'type'
-			alias: 't'
-			required: 'You have to specify a device type'
-		}
-		{
-			signature: 'drive'
-			description: 'drive'
-			parameter: 'drive'
-			alias: 'd'
-		}
-		{
-			signature: 'advanced'
-			description: 'show advanced commands'
-			boolean: true
-			alias: 'v'
-		}
-	]
-	permission: 'user'
-	root: true
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		config = require('resin-config-json')
-		visuals = require('resin-cli-visuals')
-		capitano = Promise.promisifyAll(require('capitano'))
-		umount = Promise.promisifyAll(require('umount'))
-
-		Promise.try ->
-			return options.drive or visuals.drive('Select the device drive')
-		.tap(umount.umountAsync)
-		.then (drive) ->
-			config.read(drive, options.type).get('uuid')
-				.tap ->
-					umount.umountAsync(drive)
-				.then (uuid) ->
-					configureCommand = "os configure #{drive} #{uuid}"
-					if options.advanced
-						configureCommand += ' --advanced'
-					return capitano.runAsync(configureCommand)
-		.then ->
-			console.info('Done')
-		.nodeify(done)
-
-exports.generate =
-	signature: 'config generate'
-	description: 'generate a config.json file'
-	help: '''
-		Use this command to generate a config.json for a device or application
-
-		Examples:
-
-			$ resin config generate --device 7cf02a6
-			$ resin config generate --device 7cf02a6 --output config.json
-			$ resin config generate --app MyApp
-			$ resin config generate --app MyApp --output config.json
-	'''
-	options: [
-		commandOptions.optionalApplication
-		commandOptions.optionalDevice
-		{
-			signature: 'output'
-			description: 'output'
-			parameter: 'output'
-			alias: 'o'
-		}
-	]
-	permission: 'user'
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		fs = Promise.promisifyAll(require('fs'))
-		resin = require('resin-sdk')
-		_ = require('lodash')
-		form = require('resin-cli-form')
-		deviceConfig = require('resin-device-config')
-		prettyjson = require('prettyjson')
-
-		if not options.device? and not options.application?
-			throw new Error '''
-				You have to pass either a device or an application.
-
-				See the help page for examples:
-
-				  $ resin help config generate
-			'''
-
-		Promise.try ->
-			if options.device?
-				return resin.models.device.get(options.device)
-			return resin.models.application.get(options.application)
-		.then (resource) ->
-			resin.models.device.getManifestBySlug(resource.device_type)
-				.get('options')
-				.then(form.run)
-				.then (answers) ->
-					if resource.uuid?
-						return deviceConfig.getByDevice(resource.uuid, answers)
-					return deviceConfig.getByApplication(resource.app_name, answers)
-		.then (config) ->
-			if options.output?
-				return fs.writeFileAsync(options.output, JSON.stringify(config))
-
-			console.log(prettyjson.render(config))
-		.nodeify(done)

lib/actions/device.coffee

@@ -1,424 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-commandOptions = require('./command-options')
-
-exports.list =
-	signature: 'devices'
-	description: 'list all devices'
-	help: '''
-		Use this command to list all devices that belong to you.
-
-		You can filter the devices by application by using the `--application` option.
-
-		Examples:
-
-			$ resin devices
-			$ resin devices --application MyApp
-			$ resin devices --app MyApp
-			$ resin devices -a MyApp
-	'''
-	options: [ commandOptions.optionalApplication ]
-	permission: 'user'
-	primary: true
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		_ = require('lodash')
-		resin = require('resin-sdk')
-		visuals = require('resin-cli-visuals')
-
-		Promise.try ->
-			if options.application?
-				return resin.models.device.getAllByApplication(options.application)
-			return resin.models.device.getAll()
-
-		.tap (devices) ->
-			devices = _.map devices, (device) ->
-				device.uuid = device.uuid.slice(0, 7)
-				return device
-
-			console.log visuals.table.horizontal devices, [
-				'id'
-				'uuid'
-				'name'
-				'device_type'
-				'application_name'
-				'status'
-				'is_online'
-				'supervisor_version'
-				'os_version'
-			]
-		.nodeify(done)
-
-exports.info =
-	signature: 'device <uuid>'
-	description: 'list a single device'
-	help: '''
-		Use this command to show information about a single device.
-
-		Examples:
-
-			$ resin device 7cf02a6
-	'''
-	permission: 'user'
-	primary: true
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		visuals = require('resin-cli-visuals')
-
-		resin.models.device.get(params.uuid).then (device) ->
-
-			resin.models.device.getStatus(device).then (status) ->
-				device.status = status
-
-				console.log visuals.table.vertical device, [
-					"$#{device.name}$"
-					'id'
-					'device_type'
-					'status'
-					'is_online'
-					'ip_address'
-					'application_name'
-					'last_seen'
-					'uuid'
-					'commit'
-					'supervisor_version'
-					'is_web_accessible'
-					'note'
-					'os_version'
-				]
-		.nodeify(done)
-
-exports.supported =
-	signature: 'devices supported'
-	description: 'list all supported devices'
-	help: '''
-		Use this command to get the list of all supported devices
-
-		Examples:
-
-			$ resin devices supported
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.models.config.getDeviceTypes().each (deviceType) ->
-			console.log(deviceType.slug)
-		.nodeify(done)
-
-exports.register =
-	signature: 'device register <application>'
-	description: 'register a device'
-	help: '''
-		Use this command to register a device to an application.
-
-		Examples:
-
-			$ resin device register MyApp
-	'''
-	permission: 'user'
-	options: [
-		signature: 'uuid'
-		description: 'custom uuid'
-		parameter: 'uuid'
-		alias: 'u'
-	]
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		resin = require('resin-sdk')
-
-		resin.models.application.get(params.application).then (application) ->
-
-			Promise.try ->
-				return options.uuid or resin.models.device.generateUUID()
-			.then (uuid) ->
-				console.info("Registering to #{application.app_name}: #{uuid}")
-				return resin.models.device.register(application.app_name, uuid)
-		.get('uuid')
-		.nodeify(done)
-
-exports.remove =
-	signature: 'device rm <uuid>'
-	description: 'remove a device'
-	help: '''
-		Use this command to remove a device from resin.io.
-
-		Notice this command asks for confirmation interactively.
-		You can avoid this by passing the `--yes` boolean option.
-
-		Examples:
-
-			$ resin device rm 7cf02a6
-			$ resin device rm 7cf02a6 --yes
-	'''
-	options: [ commandOptions.yes ]
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		patterns = require('../utils/patterns')
-
-		patterns.confirm(options.yes, 'Are you sure you want to delete the device?').then ->
-			resin.models.device.remove(params.uuid)
-		.nodeify(done)
-
-exports.identify =
-	signature: 'device identify <uuid>'
-	description: 'identify a device with a UUID'
-	help: '''
-		Use this command to identify a device.
-
-		In the Raspberry Pi, the ACT led is blinked several times.
-
-		Examples:
-
-			$ resin device identify 23c73a1
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.models.device.identify(params.uuid).nodeify(done)
-
-exports.reboot =
-	signature: 'device reboot <uuid>'
-	description: 'restart a device'
-	help: '''
-		Use this command to remotely reboot a device
-
-		Examples:
-
-			$ resin device reboot 23c73a1
-	'''
-	options: [ commandOptions.forceUpdateLock ]
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.models.device.reboot(params.uuid, options).nodeify(done)
-
-exports.shutdown =
-	signature: 'device shutdown <uuid>'
-	description: 'shutdown a device'
-	help: '''
-		Use this command to remotely shutdown a device
-
-		Examples:
-
-			$ resin device shutdown 23c73a1
-	'''
-	options: [ commandOptions.forceUpdateLock ]
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.models.device.shutdown(params.uuid, options).nodeify(done)
-
-exports.enableDeviceUrl =
-	signature: 'device public-url enable <uuid>'
-	description: 'enable public URL for a device'
-	help: '''
-		Use this command to enable public URL for a device
-
-		Examples:
-
-			$ resin device public-url enable 23c73a1
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.models.device.enableDeviceUrl(params.uuid).nodeify(done)
-
-exports.disableDeviceUrl =
-	signature: 'device public-url disable <uuid>'
-	description: 'disable public URL for a device'
-	help: '''
-		Use this command to disable public URL for a device
-
-		Examples:
-
-			$ resin device public-url disable 23c73a1
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.models.device.disableDeviceUrl(params.uuid).nodeify(done)
-
-exports.getDeviceUrl =
-	signature: 'device public-url <uuid>'
-	description: 'gets the public URL of a device'
-	help: '''
-		Use this command to get the public URL of a device
-
-		Examples:
-
-			$ resin device public-url 23c73a1
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.models.device.getDeviceUrl(params.uuid).then (url) ->
-			console.log(url)
-		.nodeify(done)
-
-exports.hasDeviceUrl =
-	signature: 'device public-url status <uuid>'
-	description: 'Returns true if public URL is enabled for a device'
-	help: '''
-		Use this command to determine if public URL is enabled for a device
-
-		Examples:
-
-			$ resin device public-url status 23c73a1
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		resin.models.device.hasDeviceUrl(params.uuid).then (hasDeviceUrl) ->
-			console.log(hasDeviceUrl)
-		.nodeify(done)
-
-exports.rename =
-	signature: 'device rename <uuid> [newName]'
-	description: 'rename a resin device'
-	help: '''
-		Use this command to rename a device.
-
-		If you omit the name, you'll get asked for it interactively.
-
-		Examples:
-
-			$ resin device rename 7cf02a6
-			$ resin device rename 7cf02a6 MyPi
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		_ = require('lodash')
-		resin = require('resin-sdk')
-		form = require('resin-cli-form')
-
-		Promise.try ->
-			return params.newName if not _.isEmpty(params.newName)
-
-			form.ask
-				message: 'How do you want to name this device?'
-				type: 'input'
-
-		.then(_.partial(resin.models.device.rename, params.uuid))
-		.nodeify(done)
-
-exports.move =
-	signature: 'device move <uuid>'
-	description: 'move a device to another application'
-	help: '''
-		Use this command to move a device to another application you own.
-
-		If you omit the application, you'll get asked for it interactively.
-
-		Examples:
-
-			$ resin device move 7cf02a6
-			$ resin device move 7cf02a6 --application MyNewApp
-	'''
-	permission: 'user'
-	options: [ commandOptions.optionalApplication ]
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		_ = require('lodash')
-		patterns = require('../utils/patterns')
-
-		resin.models.device.get(params.uuid).then (device) ->
-			return options.application or patterns.selectApplication (application) ->
-				return _.all [
-					application.device_type is device.device_type
-					device.application_name isnt application.app_name
-				]
-		.tap (application) ->
-			return resin.models.device.move(params.uuid, application)
-		.then (application) ->
-			console.info("#{params.uuid} was moved to #{application}")
-		.nodeify(done)
-
-exports.init =
-	signature: 'device init'
-	description: 'initialise a device with resin os'
-	help: '''
-		Use this command to download the OS image of a certain application and write it to an SD Card.
-
-		Notice this command may ask for confirmation interactively.
-		You can avoid this by passing the `--yes` boolean option.
-
-		Examples:
-
-			$ resin device init
-			$ resin device init --application MyApp
-	'''
-	options: [
-		commandOptions.optionalApplication
-		commandOptions.yes
-		{
-			signature: 'advanced'
-			description: 'enable advanced configuration'
-			boolean: true
-			alias: 'v'
-		}
-	]
-	permission: 'user'
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		capitano = Promise.promisifyAll(require('capitano'))
-		rimraf = Promise.promisify(require('rimraf'))
-		tmp = Promise.promisifyAll(require('tmp'))
-		tmp.setGracefulCleanup()
-
-		resin = require('resin-sdk')
-		helpers = require('../utils/helpers')
-		patterns = require('../utils/patterns')
-
-		Promise.try ->
-			return options.application if options.application?
-			return patterns.selectApplication()
-		.then(resin.models.application.get)
-		.then (application) ->
-
-			download = ->
-				tmp.tmpNameAsync().then (temporalPath) ->
-					capitano.runAsync("os download #{application.device_type} --output #{temporalPath}")
-				.disposer (temporalPath) ->
-					return rimraf(temporalPath)
-
-			Promise.using download(), (temporalPath) ->
-				capitano.runAsync("device register #{application.app_name}")
-					.then(resin.models.device.get)
-					.tap (device) ->
-						configure = "os configure #{temporalPath} #{device.uuid}"
-						configure += ' --advanced' if options.advanced
-						capitano.runAsync(configure).then ->
-							message = '''
-								Initializing a device requires administrative permissions
-								given that we need to access raw devices directly.
-
-							'''
-
-							helpers.sudo([ 'os', 'initialize', temporalPath, '--type', application.device_type ], message)
-
-						# Make sure the device resource is removed if there is an
-						# error when configuring or initializing a device image
-						.catch (error) ->
-							resin.models.device.remove(device.uuid).finally ->
-								throw error
-			.then (device) ->
-				console.log('Done')
-				return device.uuid
-
-		.nodeify(done)

lib/actions/environment-variables.coffee

@@ -1,182 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-commandOptions = require('./command-options')
-
-exports.list =
-	signature: 'envs'
-	description: 'list all environment variables'
-	help: '''
-		Use this command to list all environment variables for
-		a particular application or device.
-
-		This command lists all custom environment variables.
-		If you want to see all environment variables, including private
-		ones used by resin, use the verbose option.
-
-		Example:
-
-			$ resin envs --application MyApp
-			$ resin envs --application MyApp --verbose
-			$ resin envs --device 7cf02a6
-	'''
-	options: [
-		commandOptions.optionalApplication
-		commandOptions.optionalDevice
-
-		{
-			signature: 'verbose'
-			description: 'show private environment variables'
-			boolean: true
-			alias: 'v'
-		}
-	]
-	permission: 'user'
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		_ = require('lodash')
-		resin = require('resin-sdk')
-		visuals = require('resin-cli-visuals')
-
-		Promise.try ->
-			if options.application?
-				return resin.models.environmentVariables.getAllByApplication(options.application)
-			else if options.device?
-				return resin.models.environmentVariables.device.getAll(options.device)
-			else
-				throw new Error('You must specify an application or device')
-
-		.tap (environmentVariables) ->
-			if _.isEmpty(environmentVariables)
-				throw new Error('No environment variables found')
-			if not options.verbose
-				isSystemVariable = resin.models.environmentVariables.isSystemVariable
-				environmentVariables = _.reject(environmentVariables, isSystemVariable)
-
-			console.log visuals.table.horizontal environmentVariables, [
-				'id'
-				'name'
-				'value'
-			]
-		.nodeify(done)
-
-exports.remove =
-	signature: 'env rm <id>'
-	description: 'remove an environment variable'
-	help: '''
-		Use this command to remove an environment variable from an application.
-
-		Don't remove resin specific variables, as things might not work as expected.
-
-		Notice this command asks for confirmation interactively.
-		You can avoid this by passing the `--yes` boolean option.
-
-		If you want to eliminate a device environment variable, pass the `--device` boolean option.
-
-		Examples:
-
-			$ resin env rm 215
-			$ resin env rm 215 --yes
-			$ resin env rm 215 --device
-	'''
-	options: [
-		commandOptions.yes
-		commandOptions.booleanDevice
-	]
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		patterns = require('../utils/patterns')
-
-		patterns.confirm(options.yes, 'Are you sure you want to delete the environment variable?').then ->
-			if options.device
-				resin.models.environmentVariables.device.remove(params.id)
-			else
-				resin.models.environmentVariables.remove(params.id)
-		.nodeify(done)
-
-exports.add =
-	signature: 'env add <key> [value]'
-	description: 'add an environment variable'
-	help: '''
-		Use this command to add an enviroment variable to an application.
-
-		If value is omitted, the tool will attempt to use the variable's value
-		as defined in your host machine.
-
-		Use the `--device` option if you want to assign the environment variable
-		to a specific device.
-
-		If the value is grabbed from the environment, a warning message will be printed.
-		Use `--quiet` to remove it.
-
-		Examples:
-
-			$ resin env add EDITOR vim --application MyApp
-			$ resin env add TERM --application MyApp
-			$ resin env add EDITOR vim --device 7cf02a6
-	'''
-	options: [
-		commandOptions.optionalApplication
-		commandOptions.optionalDevice
-	]
-	permission: 'user'
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		resin = require('resin-sdk')
-
-		Promise.try ->
-			if not params.value?
-				params.value = process.env[params.key]
-
-				if not params.value?
-					throw new Error("Environment value not found for key: #{params.key}")
-				else
-					console.info("Warning: using #{params.key}=#{params.value} from host environment")
-
-			if options.application?
-				resin.models.environmentVariables.create(options.application, params.key, params.value)
-			else if options.device?
-				resin.models.environmentVariables.device.create(options.device, params.key, params.value)
-			else
-				throw new Error('You must specify an application or device')
-		.nodeify(done)
-
-exports.rename =
-	signature: 'env rename <id> <value>'
-	description: 'rename an environment variable'
-	help: '''
-		Use this command to rename an enviroment variable from an application.
-
-		Pass the `--device` boolean option if you want to rename a device environment variable.
-
-		Examples:
-
-			$ resin env rename 376 emacs
-			$ resin env rename 376 emacs --device
-	'''
-	permission: 'user'
-	options: [ commandOptions.booleanDevice ]
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		resin = require('resin-sdk')
-
-		Promise.try ->
-			if options.device
-				resin.models.environmentVariables.device.update(params.id, params.value)
-			else
-				resin.models.environmentVariables.update(params.id, params.value)
-		.nodeify(done)

lib/actions/help.coffee

@@ -1,126 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-_ = require('lodash')
-_.str = require('underscore.string')
-capitano = require('capitano')
-columnify = require('columnify')
-messages = require('../utils/messages')
-
-parse = (object) ->
-	return _.object _.map object, (item) ->
-
-		# Hacky way to determine if an object is
-		# a function or a command
-		if item.alias?
-			signature = item.toString()
-		else
-			signature = item.signature.toString()
-
-		return [
-			signature
-			item.description
-		]
-
-indent = (text) ->
-	text = _.map _.str.lines(text), (line) ->
-		return '    ' + line
-	return text.join('\n')
-
-print = (data) ->
-	console.log indent columnify data,
-		showHeaders: false
-		minWidth: 35
-
-general = (params, options, done) ->
-	console.log('Usage: resin [COMMAND] [OPTIONS]\n')
-	console.log("#{messages.gettingStarted}\n")
-	console.log(messages.reachingOut)
-	console.log('\nPrimary commands:\n')
-
-	# We do not want the wildcard command
-	# to be printed in the help screen.
-	commands = _.reject capitano.state.commands, (command) ->
-		return command.isWildcard()
-
-	groupedCommands = _.groupBy commands, (command) ->
-		if command.plugin
-			return 'plugins'
-		else if command.primary
-			return 'primary'
-		return 'secondary'
-
-	print(parse(groupedCommands.primary))
-
-	if options.verbose
-		if not _.isEmpty(groupedCommands.plugins)
-			console.log('\nInstalled plugins:\n')
-			print(parse(groupedCommands.plugins))
-
-		console.log('\nAdditional commands:\n')
-		print(parse(groupedCommands.secondary))
-	else
-		console.log('\nRun `resin help --verbose` to list additional commands')
-
-	if not _.isEmpty(capitano.state.globalOptions)
-		console.log('\nGlobal Options:\n')
-		print(parse(capitano.state.globalOptions))
-
-	return done()
-
-command = (params, options, done) ->
-	capitano.state.getMatchCommand params.command, (error, command) ->
-		return done(error) if error?
-
-		if not command? or command.isWildcard()
-			return done(new Error("Command not found: #{params.command}"))
-
-		console.log("Usage: #{command.signature}")
-
-		if command.help?
-			console.log("\n#{command.help}")
-		else if command.description?
-			console.log("\n#{_.str.humanize(command.description)}")
-
-		if not _.isEmpty(command.options)
-			console.log('\nOptions:\n')
-			print(parse(command.options))
-
-		return done()
-
-exports.help =
-	signature: 'help [command...]'
-	description: 'show help'
-	help: '''
-		Get detailed help for an specific command.
-
-		Examples:
-
-			$ resin help apps
-			$ resin help os download
-	'''
-	primary: true
-	options: [
-		signature: 'verbose'
-		description: 'show additional commands'
-		boolean: true
-		alias: 'v'
-	]
-	action: (params, options, done) ->
-		if params.command?
-			command(params, options, done)
-		else
-			general(params, options, done)

lib/actions/index.coffee

@@ -1,32 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-module.exports =
-	wizard: require('./wizard')
-	app: require('./app')
-	info: require('./info')
-	auth: require('./auth')
-	device: require('./device')
-	env: require('./environment-variables')
-	keys: require('./keys')
-	logs: require('./logs')
-	notes: require('./notes')
-	help: require('./help')
-	os: require('./os')
-	settings: require('./settings')
-	config: require('./config')
-	sync: require('./sync')
-	ssh: require('./ssh')

lib/actions/info.coffee

@@ -1,26 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-exports.version =
-	signature: 'version'
-	description: 'output the version number'
-	help: '''
-		Display the Resin CLI version.
-	'''
-	action: (params, options, done) ->
-		packageJSON = require('../../package.json')
-		console.log(packageJSON.version)
-		return done()

lib/actions/keys.coffee

@@ -1,122 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-commandOptions = require('./command-options')
-
-exports.list =
-	signature: 'keys'
-	description: 'list all ssh keys'
-	help: '''
-		Use this command to list all your SSH keys.
-
-		Examples:
-
-			$ resin keys
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		visuals = require('resin-cli-visuals')
-
-		resin.models.key.getAll().then (keys) ->
-			console.log visuals.table.horizontal keys, [
-				'id'
-				'title'
-			]
-		.nodeify(done)
-
-exports.info =
-	signature: 'key <id>'
-	description: 'list a single ssh key'
-	help: '''
-		Use this command to show information about a single SSH key.
-
-		Examples:
-
-			$ resin key 17
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		visuals = require('resin-cli-visuals')
-
-		resin.models.key.get(params.id).then (key) ->
-			console.log visuals.table.vertical key, [
-				'id'
-				'title'
-			]
-
-			# Since the public key string is long, it might
-			# wrap to lines below, causing the table layout to break.
-			# See https://github.com/resin-io/resin-cli/issues/151
-			console.log('\n' + key.public_key)
-		.nodeify(done)
-
-exports.remove =
-	signature: 'key rm <id>'
-	description: 'remove a ssh key'
-	help: '''
-		Use this command to remove a SSH key from resin.io.
-
-		Notice this command asks for confirmation interactively.
-		You can avoid this by passing the `--yes` boolean option.
-
-		Examples:
-
-			$ resin key rm 17
-			$ resin key rm 17 --yes
-	'''
-	options: [ commandOptions.yes ]
-	permission: 'user'
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		patterns = require('../utils/patterns')
-
-		patterns.confirm(options.yes, 'Are you sure you want to delete the key?').then ->
-			resin.models.key.remove(params.id)
-		.nodeify(done)
-
-exports.add =
-	signature: 'key add <name> [path]'
-	description: 'add a SSH key to resin.io'
-	help: '''
-		Use this command to associate a new SSH key with your account.
-
-		If `path` is omitted, the command will attempt
-		to read the SSH key from stdin.
-
-		Examples:
-
-			$ resin key add Main ~/.ssh/id_rsa.pub
-			$ cat ~/.ssh/id_rsa.pub | resin key add Main
-	'''
-	permission: 'user'
-	action: (params, options, done) ->
-		_ = require('lodash')
-		Promise = require('bluebird')
-		fs = Promise.promisifyAll(require('fs'))
-		capitano = require('capitano')
-		resin = require('resin-sdk')
-
-		Promise.try ->
-			return fs.readFileAsync(params.path, encoding: 'utf8') if params.path?
-
-			Promise.fromNode (callback) ->
-				capitano.utils.getStdin (data) ->
-					return callback(null, data)
-
-		.then(_.partial(resin.models.key.create, params.name))
-		.nodeify(done)

lib/actions/logs.coffee

@@ -1,69 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-module.exports =
-	signature: 'logs <uuid>'
-	description: 'show device logs'
-	help: '''
-		Use this command to show logs for a specific device.
-
-		By default, the command prints all log messages and exit.
-
-		To continuously stream output, and see new logs in real time, use the `--tail` option.
-
-		Note that for now you need to provide the whole UUID for this command to work correctly.
-
-		This is due to some technical limitations that we plan to address soon.
-
-		Examples:
-
-			$ resin logs 23c73a1
-			$ resin logs 23c73a1
-	'''
-	options: [
-		{
-			signature: 'tail'
-			description: 'continuously stream output'
-			boolean: true
-			alias: 't'
-		}
-	]
-	permission: 'user'
-	primary: true
-	action: (params, options, done) ->
-		_ = require('lodash')
-		resin = require('resin-sdk')
-		moment = require('moment')
-
-		printLine = (line) ->
-			timestamp = moment(line.timestamp).format('DD.MM.YY HH:mm:ss (ZZ)')
-			console.log("#{timestamp} #{line.message}")
-
-		promise = resin.logs.history(params.uuid).each(printLine)
-
-		if not options.tail
-
-			# PubNub keeps the process alive after a history query.
-			# Until this is fixed, we force the process to exit.
-			# This of course prevents this command to be used programatically
-			return promise.catch(done).finally ->
-				process.exit(0)
-
-		promise.then ->
-			resin.logs.subscribe(params.uuid).then (logs) ->
-				logs.on('line', printLine)
-				logs.on('error', done)
-		.catch(done)

lib/actions/notes.coffee

@@ -1,50 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-exports.set =
-	signature: 'note <|note>'
-	description: 'set a device note'
-	help: '''
-		Use this command to set or update a device note.
-
-		If note command isn't passed, the tool attempts to read from `stdin`.
-
-		To view the notes, use $ resin device <uuid>.
-
-		Examples:
-
-			$ resin note "My useful note" --device 7cf02a6
-			$ cat note.txt | resin note --device 7cf02a6
-	'''
-	options: [
-		signature: 'device'
-		parameter: 'device'
-		description: 'device uuid'
-		alias: [ 'd', 'dev' ]
-		required: 'You have to specify a device'
-	]
-	permission: 'user'
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		_ = require('lodash')
-		resin = require('resin-sdk')
-
-		Promise.try ->
-			if _.isEmpty(params.note)
-				throw new Error('Missing note content')
-
-			resin.models.device.note(options.device, params.note)
-		.nodeify(done)

lib/actions/os.coffee

@@ -1,190 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-commandOptions = require('./command-options')
-
-exports.download =
-	signature: 'os download <type>'
-	description: 'download an unconfigured os image'
-	help: '''
-		Use this command to download an unconfigured os image for a certain device type.
-
-		Examples:
-
-			$ resin os download parallella -o ../foo/bar/parallella.img
-	'''
-	permission: 'user'
-	options: [
-		signature: 'output'
-		description: 'output path'
-		parameter: 'output'
-		alias: 'o'
-		required: 'You have to specify an output location'
-	]
-	action: (params, options, done) ->
-		unzip = require('unzip2')
-		fs = require('fs')
-		rindle = require('rindle')
-		manager = require('resin-image-manager')
-		visuals = require('resin-cli-visuals')
-
-		console.info("Getting device operating system for #{params.type}")
-
-		manager.get(params.type).then (stream) ->
-			bar = new visuals.Progress('Downloading Device OS')
-			spinner = new visuals.Spinner('Downloading Device OS (size unknown)')
-
-			stream.on 'progress', (state) ->
-				if state?
-					bar.update(state)
-				else
-					spinner.start()
-
-			stream.on 'end', ->
-				spinner.stop()
-
-			# We completely rely on the `mime` custom property
-			# to make this decision.
-			# The actual stream should be checked instead.
-			if stream.mime is 'application/zip'
-				output = unzip.Extract(path: options.output)
-			else
-				output = fs.createWriteStream(options.output)
-
-			return rindle.wait(stream.pipe(output)).return(options.output)
-		.tap (output) ->
-			console.info('The image was downloaded successfully')
-		.nodeify(done)
-
-stepHandler = (step) ->
-	_ = require('lodash')
-	rindle = require('rindle')
-	visuals = require('resin-cli-visuals')
-	helpers = require('../utils/helpers')
-
-	step.on('stdout', _.bind(process.stdout.write, process.stdout))
-	step.on('stderr', _.bind(process.stderr.write, process.stderr))
-
-	step.on 'state', (state) ->
-		return if state.operation.command is 'burn'
-		console.log(helpers.stateToString(state))
-
-	bar = new visuals.Progress('Writing Device OS')
-
-	step.on('burn', _.bind(bar.update, bar))
-
-	return rindle.wait(step)
-
-exports.configure =
-	signature: 'os configure <image> <uuid>'
-	description: 'configure an os image'
-	help: '''
-		Use this command to configure a previously download operating system image with a device.
-
-		Examples:
-
-			$ resin os configure ../path/rpi.img 7cf02a6
-	'''
-	permission: 'user'
-	options: [
-		signature: 'advanced'
-		description: 'show advanced commands'
-		boolean: true
-		alias: 'v'
-	]
-	action: (params, options, done) ->
-		_ = require('lodash')
-		resin = require('resin-sdk')
-		form = require('resin-cli-form')
-		init = require('resin-device-init')
-		helpers = require('../utils/helpers')
-
-		console.info('Configuring operating system image')
-		resin.models.device.get(params.uuid).then (device) ->
-			helpers.getManifest(params.image, device.device_type)
-			.get('options')
-			.then (questions) ->
-
-				if not options.advanced
-					advancedGroup = _.findWhere questions,
-						name: 'advanced'
-						isGroup: true
-
-					if advancedGroup?
-						override = helpers.getGroupDefaults(advancedGroup)
-
-				return form.run(questions, { override })
-			.then (answers) ->
-				init.configure(params.image, params.uuid, answers).then(stepHandler)
-		.nodeify(done)
-
-exports.initialize =
-	signature: 'os initialize <image>'
-	description: 'initialize an os image'
-	help: '''
-		Use this command to initialize a previously configured operating system image.
-
-		Examples:
-
-			$ resin os initialize ../path/rpi.img --type 'raspberry-pi'
-	'''
-	permission: 'user'
-	options: [
-		commandOptions.yes
-		{
-			signature: 'type'
-			description: 'device type'
-			parameter: 'type'
-			alias: 't'
-			required: 'You have to specify a device type'
-		}
-		{
-			signature: 'drive'
-			description: 'drive'
-			parameter: 'drive'
-			alias: 'd'
-		}
-	]
-	root: true
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		umount = Promise.promisifyAll(require('umount'))
-		form = require('resin-cli-form')
-		init = require('resin-device-init')
-		patterns = require('../utils/patterns')
-		helpers = require('../utils/helpers')
-
-		console.info('Initializing device')
-		helpers.getManifest(params.image, options.type)
-			.then (manifest) ->
-				return manifest.initialization?.options
-			.then (questions) ->
-				return form.run questions,
-					override:
-						drive: options.drive
-			.tap (answers) ->
-				return if not answers.drive?
-				message = "This will erase #{answers.drive}. Are you sure?"
-				patterns.confirm(options.yes, message)
-					.return(answers.drive)
-					.then(umount.umountAsync)
-			.tap (answers) ->
-				return init.initialize(params.image, options.type, answers).then(stepHandler)
-			.then (answers) ->
-				return if not answers.drive?
-				umount.umountAsync(answers.drive).tap ->
-					console.info("You can safely remove #{answers.drive} now")
-		.nodeify(done)

lib/actions/settings.coffee

@@ -1,34 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-exports.list =
-	signature: 'settings'
-	description: 'print current settings'
-	help: '''
-		Use this command to display detected settings
-
-		Examples:
-
-			$ resin settings
-	'''
-	action: (params, options, done) ->
-		resin = require('resin-sdk')
-		prettyjson = require('prettyjson')
-
-		resin.settings.getAll()
-			.then(prettyjson.render)
-			.then(console.log)
-			.nodeify(done)

lib/actions/ssh.coffee

@@ -1,107 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-# TODO: A function to reliably execute a command
-# in all supported operating systems, including
-# different Windows environments like `cmd.exe`
-# and `Cygwin` should be encapsulated in a
-# re-usable package.
-# This is literally copy-pasted from the `resin-sync`
-# module.
-getSubShellCommand = (command) ->
-	os = require('os')
-
-	if os.platform() is 'win32'
-		return {
-			program: 'cmd.exe'
-			args: [ '/s', '/c', command ]
-		}
-	else
-		return {
-			program: '/bin/sh'
-			args: [ '-c', command ]
-		}
-
-module.exports =
-	signature: 'ssh [uuid]'
-	description: '(beta) get a shell into the running app container of a device'
-	help: '''
-		WARNING: If you're running Windows, this command only supports `cmd.exe`.
-
-		Use this command to get a shell into the running application container of
-		your device.
-
-		Examples:
-
-			$ resin ssh MyApp
-			$ resin ssh 7cf02a6
-			$ resin ssh 7cf02a6 --port 8080
-			$ resin ssh 7cf02a6 -v
-	'''
-	permission: 'user'
-	primary: true
-	options: [
-			signature: 'port'
-			parameter: 'port'
-			description: 'ssh gateway port'
-			alias: 'p'
-	,
-			signature: 'verbose'
-			boolean: true
-			description: 'increase verbosity'
-			alias: 'v'
-	]
-	action: (params, options, done) ->
-		child_process = require('child_process')
-		Promise = require 'bluebird'
-		resin = require('resin-sdk')
-		settings = require('resin-settings-client')
-		patterns = require('../utils/patterns')
-
-		if not options.port?
-			options.port = 22
-
-		verbose = if options.verbose then '-vvv' else ''
-
-		resin.models.device.has(params.uuid).then (isValidUUID) ->
-			if isValidUUID
-				return params.uuid
-
-			return patterns.inferOrSelectDevice()
-		.then (uuid) ->
-			console.info("Connecting with: #{uuid}")
-			resin.models.device.get(uuid)
-		.then (device) ->
-			throw new Error('Device is not online') if not device.is_online
-
-			Promise.props
-				username: resin.auth.whoami()
-				uuid: device.uuid		# get full uuid
-				containerId: resin.models.device.getApplicationInfo(device.uuid).get('containerId')
-			.then ({ username, uuid, containerId }) ->
-				throw new Error('Did not find running application container') if not containerId?
-				Promise.try ->
-					command = "ssh #{verbose} -t \
-						-o LogLevel=ERROR \
-						-o StrictHostKeyChecking=no \
-						-o UserKnownHostsFile=/dev/null \
-						-o ControlMaster=no \
-						-p #{options.port} #{username}@ssh.#{settings.get('proxyUrl')} enter #{uuid} #{containerId}"
-
-					subShellCommand = getSubShellCommand(command)
-					spawn = child_process.spawn subShellCommand.program, subShellCommand.args,
-						stdio: 'inherit'
-		.nodeify(done)

lib/actions/sync.coffee

@@ -1,162 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-# Loads '.resin-sync.yml' configuration from 'source' directory.
-# Returns the configuration object on success
-#
-# TODO: Use 'config.load()' method from `resin sync` when resin sync gets
-# integrated into resin CLI
-loadConfig = (source) ->
-	fs = require('fs')
-	path = require('path')
-	_ = require('lodash')
-	jsYaml = require('js-yaml')
-
-	configPath = path.join(source, '.resin-sync.yml')
-	try
-		config = fs.readFileSync(configPath, encoding: 'utf8')
-		result = jsYaml.safeLoad(config)
-	catch error
-		# return empty object if '.resin-sync.yml' is missing
-		if error.code is 'ENOENT'
-			return {}
-		throw error
-
-	if not _.isPlainObject(result)
-		throw new Error("Invalid configuration file: #{configPath}")
-
-	return result
-
-module.exports =
-	signature: 'sync [uuid]'
-	description: '(beta) sync your changes to a device'
-	help: '''
-		WARNING: If you're running Windows, this command only supports `cmd.exe`.
-
-		Use this command to sync your local changes to a certain device on the fly.
-
-		After every 'resin sync' the updated settings will be saved in
-		'<source>/.resin-sync.yml' and will be used in later invocations. You can
-		also change any option by editing '.resin-sync.yml' directly.
-
-		Here is an example '.resin-sync.yml' :
-
-			$ cat $PWD/.resin-sync.yml
-			uuid: 7cf02a6
-			destination: '/usr/src/app'
-			before: 'echo Hello'
-			after: 'echo Done'
-			ignore:
-				- .git
-				- node_modules/
-
-		Command line options have precedence over the ones saved in '.resin-sync.yml'.
-
-		If '.gitignore' is found in the source directory then all explicitly listed files will be
-		excluded from the syncing process. You can choose to change this default behavior with the
-		'--skip-gitignore' option.
-
-		Examples:
-
-			$ resin sync 7cf02a6 --source . --destination /usr/src/app
-			$ resin sync 7cf02a6 -s /home/user/myResinProject -d /usr/src/app --before 'echo Hello' --after 'echo Done'
-			$ resin sync --ignore lib/
-			$ resin sync --verbose false
-			$ resin sync
-	'''
-	permission: 'user'
-	primary: true
-	options: [
-			signature: 'source'
-			parameter: 'path'
-			description: 'local directory path to synchronize to device'
-			alias: 's'
-		,
-			signature: 'destination'
-			parameter: 'path'
-			description: 'destination path on device'
-			alias: 'd'
-		,
-			signature: 'ignore'
-			parameter: 'paths'
-			description: 'comma delimited paths to ignore when syncing'
-			alias: 'i'
-		,
-			signature: 'skip-gitignore'
-			boolean: true
-			description: 'do not parse excluded/included files from .gitignore'
-		,
-			signature: 'before'
-			parameter: 'command'
-			description: 'execute a command before syncing'
-			alias: 'b'
-		,
-			signature: 'after'
-			parameter: 'command'
-			description: 'execute a command after syncing'
-			alias: 'a'
-		,
-			signature: 'port'
-			parameter: 'port'
-			description: 'ssh port'
-			alias: 't'
-		,
-			signature: 'progress'
-			boolean: true
-			description: 'show progress'
-			alias: 'p'
-		,
-			signature: 'verbose'
-			boolean: true
-			description: 'increase verbosity'
-			alias: 'v'
-		,
-	]
-	action: (params, options, done) ->
-		fs = require('fs')
-		path = require('path')
-		resin = require('resin-sdk')
-		Promise = require('bluebird')
-		resinSync = require('resin-sync')
-		patterns = require('../utils/patterns')
-
-		Promise.try ->
-			try
-				fs.accessSync(path.join(process.cwd(), '.resin-sync.yml'))
-			catch
-				if not options.source?
-					throw new Error('No --source option passed and no \'.resin-sync.yml\' file found in current directory.')
-
-			options.source ?= process.cwd()
-
-			# TODO: Add comma separated options to Capitano
-			if options.ignore?
-				options.ignore = options.ignore.split(',')
-
-			Promise.resolve(params.uuid)
-			.then (uuid) ->
-				if not uuid?
-					savedUuid = loadConfig(options.source).uuid
-					return patterns.inferOrSelectDevice(savedUuid)
-
-				resin.models.device.has(uuid)
-				.then (hasDevice) ->
-					if not hasDevice
-						throw new Error("Device not found: #{uuid}")
-					return uuid
-			.then (uuid) ->
-				resinSync.sync(uuid, options)
-		.nodeify(done)

lib/actions/wizard.coffee

@@ -1,75 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-exports.wizard =
-	signature: 'quickstart [name]'
-	description: 'getting started with resin.io'
-	help: '''
-		Use this command to run a friendly wizard to get started with resin.io.
-
-		The wizard will guide you through:
-
-			- Create an application.
-			- Initialise an SDCard with the resin.io operating system.
-			- Associate an existing project directory with your resin.io application.
-			- Push your project to your devices.
-
-		Examples:
-
-			$ resin quickstart
-			$ resin quickstart MyApp
-	'''
-	primary: true
-	action: (params, options, done) ->
-		Promise = require('bluebird')
-		capitano = Promise.promisifyAll(require('capitano'))
-		resin = require('resin-sdk')
-		patterns = require('../utils/patterns')
-
-		resin.auth.isLoggedIn().then (isLoggedIn) ->
-			return if isLoggedIn
-			console.info('Looks like you\'re not logged in yet!')
-			console.info('Lets go through a quick wizard to get you started.\n')
-			return capitano.runAsync('login')
-		.then ->
-			return if params.name?
-			patterns.selectOrCreateApplication().tap (applicationName) ->
-				resin.models.application.has(applicationName).then (hasApplication) ->
-					return applicationName if hasApplication
-					capitano.runAsync("app create #{applicationName}")
-			.then (applicationName) ->
-				params.name = applicationName
-		.then ->
-			return capitano.runAsync("device init --application #{params.name}")
-		.tap(patterns.awaitDevice)
-		.then (uuid) ->
-			return capitano.runAsync("device #{uuid}")
-		.then ->
-			return resin.models.application.get(params.name)
-		.then (application) ->
-			console.log """
-				Your device is ready to start pushing some code!
-
-				Check our official documentation for more information:
-
-				    http://docs.resin.io/#/pages/introduction/introduction.md
-
-				Clone an example or go to an existing application directory and run:
-
-				    $ git remote add resin #{application.git_repository}
-				    $ git push resin master
-			"""
-		.nodeify(done)

lib/app.coffee

@@ -1,137 +0,0 @@
-###
-Copyright 2016 Resin.io
-
-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.
-###
-
-_ = require('lodash')
-Promise = require('bluebird')
-capitano = Promise.promisifyAll(require('capitano'))
-resin = require('resin-sdk')
-actions = require('./actions')
-errors = require('./errors')
-events = require('./events')
-plugins = require('./utils/plugins')
-update = require('./utils/update')
-
-capitano.permission 'user', (done) ->
-	resin.auth.isLoggedIn().then (isLoggedIn) ->
-		if not isLoggedIn
-			throw new Error '''
-				You have to log in to continue
-
-				Run the following command to go through the login wizard:
-
-				  $ resin login
-			'''
-	.nodeify(done)
-
-capitano.command
-	signature: '*'
-	action: ->
-		capitano.execute(command: 'help')
-
-capitano.globalOption
-	signature: 'help'
-	boolean: true
-	alias: 'h'
-
-# ---------- Info Module ----------
-capitano.command(actions.info.version)
-
-# ---------- Help Module ----------
-capitano.command(actions.help.help)
-
-# ---------- Wizard Module ----------
-capitano.command(actions.wizard.wizard)
-
-# ---------- Auth Module ----------
-capitano.command(actions.auth.login)
-capitano.command(actions.auth.logout)
-capitano.command(actions.auth.signup)
-capitano.command(actions.auth.whoami)
-
-# ---------- App Module ----------
-capitano.command(actions.app.create)
-capitano.command(actions.app.list)
-capitano.command(actions.app.remove)
-capitano.command(actions.app.restart)
-capitano.command(actions.app.info)
-
-# ---------- Device Module ----------
-capitano.command(actions.device.list)
-capitano.command(actions.device.supported)
-capitano.command(actions.device.rename)
-capitano.command(actions.device.init)
-capitano.command(actions.device.remove)
-capitano.command(actions.device.identify)
-capitano.command(actions.device.reboot)
-capitano.command(actions.device.shutdown)
-capitano.command(actions.device.enableDeviceUrl)
-capitano.command(actions.device.disableDeviceUrl)
-capitano.command(actions.device.getDeviceUrl)
-capitano.command(actions.device.hasDeviceUrl)
-capitano.command(actions.device.register)
-capitano.command(actions.device.move)
-capitano.command(actions.device.info)
-
-# ---------- Notes Module ----------
-capitano.command(actions.notes.set)
-
-# ---------- Keys Module ----------
-capitano.command(actions.keys.list)
-capitano.command(actions.keys.add)
-capitano.command(actions.keys.info)
-capitano.command(actions.keys.remove)
-
-# ---------- Env Module ----------
-capitano.command(actions.env.list)
-capitano.command(actions.env.add)
-capitano.command(actions.env.rename)
-capitano.command(actions.env.remove)
-
-# ---------- OS Module ----------
-capitano.command(actions.os.download)
-capitano.command(actions.os.configure)
-capitano.command(actions.os.initialize)
-
-# ---------- Config Module ----------
-capitano.command(actions.config.read)
-capitano.command(actions.config.write)
-capitano.command(actions.config.inject)
-capitano.command(actions.config.reconfigure)
-capitano.command(actions.config.generate)
-
-# ---------- Settings Module ----------
-capitano.command(actions.settings.list)
-
-# ---------- Logs Module ----------
-capitano.command(actions.logs)
-
-# ---------- Sync Module ----------
-capitano.command(actions.sync)
-
-# ---------- SSH Module ----------
-capitano.command(actions.ssh)
-
-update.notify()
-
-plugins.register(/^resin-plugin-(.+)$/).then ->
-	cli = capitano.parse(process.argv)
-
-	events.trackCommand(cli).then ->
-		if cli.global?.help
-			return capitano.executeAsync(command: "help #{cli.command ? ''}")
-		capitano.executeAsync(cli)
-
-.catch(errors.handle)

lib/app.ts

@@ -0,0 +1,152 @@
+/**
+ * @license
+ * 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.
+ * 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 packageJSON from '../package.json';
+import { CliSettings } from './utils/bootstrap';
+import { onceAsync, stripIndent } from './utils/lazy';
+
+/**
+ * Sentry.io setup
+ * @see https://docs.sentry.io/error-reporting/quickstart/?platform=node
+ */
+export const setupSentry = onceAsync(async () => {
+	const config = await import('./config');
+	const Sentry = await import('@sentry/node');
+	Sentry.init({
+		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();
+});
+
+async function checkNodeVersion() {
+	const validNodeVersions = packageJSON.engines.node;
+	if (!(await import('semver')).satisfies(process.version, validNodeVersions)) {
+		console.warn(stripIndent`
+			------------------------------------------------------------------------------
+			Warning: Node version "${process.version}" does not match required versions "${validNodeVersions}".
+			This may cause unexpected behavior. To upgrade Node, visit:
+			https://nodejs.org/en/download/
+			------------------------------------------------------------------------------
+			`);
+	}
+}
+
+/** 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'),
+	});
+}
+
+/**
+ * Addresses the console warning:
+ * (node:49500) MaxListenersExceededWarning: Possible EventEmitter memory
+ * leak detected. 11 error listeners added. Use emitter.setMaxListeners() to
+ * increase limit
+ */
+export function setMaxListeners(maxListeners: number) {
+	require('events').EventEmitter.defaultMaxListeners = maxListeners;
+}
+
+/** Selected CLI initialization steps */
+async function init() {
+	if (process.env.BALENARC_NO_SENTRY) {
+		console.error(`WARN: disabling Sentry.io error reporting`);
+	} else {
+		await setupSentry();
+	}
+	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
+	(await import('./utils/update')).notify();
+}
+
+/** Execute the oclif parser and the CLI command. */
+async function oclifRun(
+	command: string[],
+	options: import('./preparser').AppOptions,
+) {
+	const { CustomMain } = await import('./utils/oclif-utils');
+	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;
+			}
+		},
+	);
+	const { trackPromise } = await import('./hooks/prerun/track');
+	await Promise.all([trackPromise, runPromise]);
+}
+
+/** CLI entrypoint. Called by the `bin/balena` and `bin/balena-dev` scripts. */
+export async function run(
+	cliArgs = process.argv,
+	options: import('./preparser').AppOptions = {},
+) {
+	try {
+		const { normalizeEnvVars, pkgExec } = await import('./utils/bootstrap');
+		normalizeEnvVars();
+
+		// The 'pkgExec' special/internal command provides a Node.js interpreter
+		// for use of the standalone zip package. See pkgExec function.
+		if (cliArgs.length > 3 && cliArgs[2] === 'pkgExec') {
+			return pkgExec(cliArgs[3], cliArgs.slice(4));
+		}
+
+		await init();
+
+		const { preparseArgs, checkDeletedCommand } = await import('./preparser');
+
+		// 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 {
+		// Windows fix: reading from stdin prevents the process from exiting
+		process.stdin.pause();
+	}
+}

lib/auth/index.ts

@@ -0,0 +1,66 @@
+/*
+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 { getBalenaSdk } from '../utils/lazy';
+import { LoginServer } from './server';
+
+/**
+ * @module auth
+ */
+
+/**
+ * @summary Login to the balena CLI using the web dashboard
+ * @function
+ * @public
+ *
+ * @description
+ * This function opens the user's default browser and points it
+ * to the balena dashboard where the session token exchange will
+ * take place.
+ *
+ * Once the the token is retrieved, it's automatically persisted.
+ *
+ * @fulfil {String} - session token
+ * @returns {Promise}
+ *
+ * @example
+ * auth.login().then (sessionToken) ->
+ *   console.log('I\'m logged in!')
+ *   console.log("My session token is: #{sessionToken}")
+ */
+export async function login({ host = '127.0.0.1', port = 0 }) {
+	const utils = await import('./utils');
+
+	const loginServer = new LoginServer();
+	const {
+		host: actualHost,
+		port: actualPort,
+		urlPath,
+	} = await loginServer.start({ host, port });
+
+	const callbackUrl = `http://${actualHost}:${actualPort}${urlPath}`;
+	const loginUrl = await utils.getDashboardLoginURL(callbackUrl);
+
+	console.info(`Opening web browser for URL:\n${loginUrl}`);
+	const open = await import('open');
+	open(loginUrl, { wait: false });
+
+	const balena = getBalenaSdk();
+	const token = await loginServer.awaitForToken();
+	await balena.auth.loginWithToken(token);
+	loginServer.shutdown();
+	return token;
+}

lib/auth/pages/error.ejs

@@ -0,0 +1,22 @@
+<!doctype html>
+<html>
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="x-ua-compatible" content="ie=edge">
+	<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>
+</head>
+<body>
+	<div class="center">
+		<img class="icon" src="./static/images/sad.png" inline>
+		<h1>Something went wrong</h1>
+		<br>
+		<p>The balena CLI login was not successful.</p>
+		<br>
+		<br>
+		<a href="https://forums.balena.io/" class="button danger">Get help in our forums</a>
+	</div>
+</body>
+</html>