The official balena CLI tool.
Go to file
2020-09-19 12:23:16 +03:00
.github Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
.versionbot v12.22.1 2020-09-19 12:23:16 +03:00
automation Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
bin Use @balena/es-version to set the desired es version for modules 2020-06-29 21:25:48 +00:00
doc Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
lib Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
patches Improve command suggestions, add topic help 2020-09-10 15:56:45 +02:00
tests Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
typings Convert command preload to oclif, typescript 2020-08-27 10:19:54 +02:00
.editorconfig fix resin local push help message and lint errors 2017-03-21 12:06:05 +03:00
.gitattributes Allow rebasing of npm-shrinkwrap 2020-08-12 14:46:51 +01:00
.gitignore Generate/include an oclif.manifest.json when packaging 2020-06-30 14:02:02 +00:00
.hound.yml Convert gulpfile.coffee to javascript 2020-04-30 17:58:13 +01:00
.prettierrc Fix prettier configuration to avoid linting errors 2018-03-05 16:02:09 +01:00
.resinci.yml CI: Avoid duplicate windows/mac tests 2020-08-11 12:32:36 +01:00
.travis.yml Add 'npm run package' command 2019-07-04 20:01:07 +01:00
appveyor.yml Add 'npm run package' command 2019-07-04 20:01:07 +01:00
balena-completion.bash Remove 'signup' command 2019-06-04 17:06:46 +01:00
CHANGELOG.md v12.22.1 2020-09-19 12:23:16 +03:00
CONTRIBUTING.md Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
gulpfile.js Convert gulpfile.coffee to javascript 2020-04-30 17:58:13 +01:00
INSTALL-ADVANCED.md Reorganize and simplify installation instructions 2020-09-18 14:13:32 +01:00
INSTALL-LINUX.md Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
INSTALL-MAC.md Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
INSTALL-WINDOWS.md Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
INSTALL.md Reorganize and simplify installation instructions 2020-09-18 14:13:32 +01:00
LICENSE Change license to Apache 2.0 2016-01-03 23:58:51 -04:00
npm-shrinkwrap.json v12.22.1 2020-09-19 12:23:16 +03:00
package.json v12.22.1 2020-09-19 12:23:16 +03:00
README.md Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
repo.yml Update balena-sdk to 15.x 2020-08-11 17:53:33 +01:00
TROUBLESHOOTING.md Style "balena CLI" as "balenaCLI" and "balena cloud" as "balenaCloud" 2020-09-18 23:27:24 +01:00
tsconfig.dev.json Add ability to conditionally apply patches per platform (Linux, Mac, Windows) 2020-07-15 16:30:15 +00:00
tsconfig.js.json Use balena-lint for javascript linting and add javascript type-checking 2020-03-25 12:12:03 +00:00
tsconfig.json Be lazier with imports in oclif actions 2020-07-09 15:03:38 +01:00
tslint.json Enforce and improve lazy loading of resin-cli-form 2020-07-09 10:51:10 +01:00

balenaCLI

The official balena Command Line Interface.

npm version dependencies

About

balenaCLI is a Command Line Interface for balenaCloud or openBalena. 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. balenaCLI builds on the balena API and the balena SDK, and can also be directly imported in Node.js applications. balenaCLI is an open-source project on GitHub, and your contribution is also welcome!

Installation

Check the balenaCLI installation instructions on GitHub.

Choosing a shell (command prompt/terminal)

On Windows, the standard Command Prompt (cmd.exe) and PowerShell are supported. Alternative shells include:

  • MSYS2:
  • MSYS: select the msys-rsync and msys-openssh packages too
  • Git for Windows
    • 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 mentioned above (Git for Windows actually uses MSYS2). For a screenshot, check this comment.
  • Microsoft's Windows Subsystem for Linux (WSL). In this case, a Linux distribution like Ubuntu is installed via the Microsoft Store, and a balenaCLI release for Linux should be selected. See FAQ for using balenaCLI 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 file to your system's bash_completion directory: check Docker's command completion guide 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:

$ balena login

Proxy support

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. It may be:

    • A string in URL format, e.g. proxy: 'http://localhost:8000'

    • An object in the format:

      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 package (command-line tool) to be installed. proxytunnel is available for Linux distributions like Ubuntu/Debian (apt install proxytunnel), and for macOS through Homebrew. Windows support is limited to the Windows Subsystem for Linux (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 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 balenaCLI version 11.30.8 or later. In the case of the npm installation option, 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 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.*'

Matched patterns are excluded from proxying. Wildcard expressions are documented at matcher. 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.

Command reference documentation

The full CLI command reference is available on the web or by running balena help --verbose.

Support, FAQ and troubleshooting

If you come across any problems or would like to get in touch:

Deprecation policy

balenaCLI uses semver versioning, with the concepts of major, minor and patch version releases.

The latest release of a major version of balenaCLI 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, balenaCLI 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.

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 balenaCLI to the latest version.

Contributing (including editing documentation files)

Please have a look at the 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!

License

The project is licensed under the Apache 2.0 License. A copy is also available in the LICENSE file in this repository.