ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2024-12-19 05:37:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
The official balena CLI tool.
2,335 Commits 93 Branches 1,080 Tags 47 MiB
TypeScript 97.9%
JavaScript 1.5%
Shell 0.4%
EJS 0.1%
0ee73f5164
Go to file
Cameron Diver 0ee73f5164 Don't require a login for commands operating on local devices 
Change-type: patch
Closes: #1195
Signed-off-by: Cameron Diver <cameron@balena.io>
2019-06-04 13:52:35 +01:00
.github Add maintainer, reviewers, and devexp team as code owners 2019-03-12 13:34:27 +00:00
automation Remove or move most local namespaced commands 2019-06-04 13:52:34 +01:00
bin Add native installers for Windows and macOS 2019-06-04 13:52:33 +01:00
doc Don't require a login for commands operating on local devices 2019-06-04 13:52:35 +01:00
lib Don't require a login for commands operating on local devices 2019-06-04 13:52:35 +01:00
patches Add native installers for Windows and macOS 2019-06-04 13:52:33 +01:00
tests Rename everything from 'resin' to 'balena' 2018-10-29 22:29:02 +01:00
typings Update balena ssh command to support local devices and multicontainer 2019-06-04 13:51:57 +01:00
.editorconfig fix resin local push help message and lint errors 2017-03-21 12:06:05 +03:00
.gitignore Add native installers for Windows and macOS 2019-06-04 13:52:33 +01:00
.hound.yml Change java_script to javascript in hound config 2015-10-19 14:21:10 -04:00
.npmrc Use an .npmrc to prevent creating a package-lock on each install 2019-05-31 16:52:55 +03:00
.prettierrc Fix prettier configuration to avoid linting errors 2018-03-05 16:02:09 +01:00
.resinci.yml Update README and INSTALL docs (review typos and some rewording) 2019-05-01 18:15:47 +01:00
.travis.yml Add native installers for Windows and macOS 2019-06-04 13:52:33 +01:00
appveyor.yml Add native installers for Windows and macOS 2019-06-04 13:52:33 +01:00
balena-completion.bash Rename everything from 'resin' to 'balena' 2018-10-29 22:29:02 +01:00
CHANGELOG.md v10.17.5 2019-06-04 09:10:48 +03:00
coffeelint.json Add Coffeelint support 2014-10-31 09:48:53 -04:00
CONTRIBUTING.md Add CONTRIBUTING.md and some guidance on commit messages and doc files. 2019-06-04 13:51:59 +01:00
gulpfile.coffee dependencies: bump gulp to v4 2019-05-02 11:53:54 +01:00
INSTALL.md Update the CLI's installation instructions for executable installers 2019-06-04 13:52:34 +01:00
LICENSE Change license to Apache 2.0 2016-01-03 23:58:51 -04:00
package.json Add native installers for Windows and macOS 2019-06-04 13:52:33 +01:00
README.md Add CONTRIBUTING.md and some guidance on commit messages and doc files. 2019-06-04 13:51:59 +01:00
TROUBLESHOOTING.md Unify the CLI instructions between capitanodoc.ts and README.md, move 2019-04-29 14:27:32 +01:00
tsconfig.json Bump min Node.js version to 8.0, ts-node to 8.1 and typescript to 3.4. 2019-06-04 13:51:55 +01:00
tslint.json Add tslint config to enable consistent lint process 2019-04-24 12:48:52 +01:00

README.md

balena CLI

The official balena CLI tool.

npm version dependencies Gitter

About

The balena CLI (Command-Line Interface) allows you to interact with the balenaCloud and the balena API through a terminal window on Linux, macOS or Windows. You can also write shell scripts around it, or import its Node.js modules to use it programmatically. As an open-source project on GitHub, your contribution is also welcome!

Installation

Check the balena CLI installation instructions on GitHub.

Getting Started

Choosing a shell (command prompt/terminal)

On Windows, the standard Command Prompt (cmd.exe) and PowerShell are supported. We are aware of users also having a good experience with alternative shells, including:

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 order of preference:

  • Set the BALENARC_PROXY environment variable in URL format (with protocol, host, port, and optionally basic auth).
  • Alternatively, use the balena config file (project-specific or user-level) and set the proxy setting. It can be:
  • Alternatively, set the conventional https_proxy / HTTPS_PROXY / http_proxy / HTTP_PROXY environment variable (in the same standard URL format).

To get a proxy to work with the balena ssh command, check the installation instructions.

Command reference documentation

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

Support, FAQ and troubleshooting

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

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.