abf573fa47
zero in device UUID). This commit is fairly chunky because it adds the oclif dependency for the first time, and refactors the CLI help and docs generation code to accommodate both Capitano and oclif. Change-type: patch Signed-off-by: Paulo Castro <paulo@balena.io> |
||
|---|---|---|
| .github | ||
| automation | ||
| bin | ||
| doc | ||
| lib | ||
| patches | ||
| tests | ||
| typings | ||
| .editorconfig | ||
| .gitignore | ||
| .hound.yml | ||
| .npmrc | ||
| .prettierrc | ||
| .resinci.yml | ||
| .travis.yml | ||
| appveyor.yml | ||
| balena-completion.bash | ||
| CHANGELOG.md | ||
| coffeelint.json | ||
| gulpfile.coffee | ||
| INSTALL.md | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| TROUBLESHOOTING.md | ||
| tsconfig.json | ||
| tslint.json | ||
balena CLI
The official balena CLI tool.
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:
- Microsoft's Windows Subsystem for Linux (a.k.a. Microsoft's "bash for Windows 10").
- Git for Windows.
- MinGW: install the
msys-rsyncandmsys-opensshpackages too.
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:
- A string in URL format, or
- An object in the global-tunnel-ng options format (which allows more control).
- 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:
- Check our FAQ / troubleshooting document.
- Ask us a question through the balenaCloud forum.
- For bug reports or feature requests, have a look at the GitHub issues or create a new one.
Contributing
The balena CLI is an open source project and your contribution is welcome!
The CLI was originally written in CoffeeScript, but we have decided to migrate to TypeScript in order to take advantage of static typing and formal programming interfaces. The migration is taking place gradually, as part of maintenance work or the implementation of new features.
After cloning this repository and running npm install you can build the CLI using npm run build.
You can then run the generated build using ./bin/balena.
In order to ease development:
- you can build the CLI using the
npm run build:fastvariant which skips some of the build steps or - you can use
./bin/balena-devwhich live transpiles the sources of the CLI.
In either case, before opening a PR be sure to also test your changes with npm test.
Note on editing this README document
This file is edited/created by hand, but it is then automatically parsed to extract selected
subsections for the CLI's web documentation page.
The code that parses this file is in automation/capitanodoc/capitanodoc.ts
.
License
The project is licensed under the Apache 2.0 License. A copy is also available in the LICENSE file in this repository.