LinuxCommandLibrary

balena

Manage balenaCloud application deployments

TLDR

Log in to the balenaCloud account

$ balena login
copy

Create a balenaCloud or openBalena application
$ balena app create [app_name]
copy

List all balenaCloud or openBalena applications within the account
$ balena apps
copy

List all devices associated with the balenaCloud or openBalena account
$ balena devices
copy

Flash a balenaOS image to a local drive
$ balena local flash [path/to/balenaos.img] --drive [drive_location]
copy

SYNOPSIS

balena command [options]

PARAMETERS

help
    Display help information about balena and its commands.

version
    Show balena CLI version.

login
    Authenticate with balenaCloud.

logout
    Log out of balenaCloud.

push
    Build and push an application to balenaCloud.

deploy
    Deploy an application to balenaCloud.

devices
    List devices in a balenaCloud application.

device
    Show information about a specific device.

logs
    View logs from a specific device.

ssh
    Open an SSH connection to a device.

tunnel
    Open a local port tunnel to a device.

preload
    Preload application image to a balenaOS image

build
    Build a container image for a balena application.

scan
    Scan for local balenaOS devices.

config
    Configure balena CLI settings.

DESCRIPTION

The balenaCLI is a command-line tool for building, pushing, and managing applications on the balena platform. It facilitates the development, deployment, and monitoring of containerized applications for IoT devices.

With balenaCLI, developers can build container images from Dockerfiles, push them to the balenaCloud registry, manage devices within a balena fleet, access device logs, and interact with devices remotely via a shell.

The tool simplifies the often complex process of deploying applications to remote embedded devices, by abstracting away much of the underlying infrastructure management. It supports various balenaCloud features, including device configuration, environment variables, and over-the-air (OTA) updates. Developers can use the tool to build and test their applications locally before deploying them to devices remotely.

This command-line interface is a key part of the balena ecosystem, enabling developers to effectively manage their IoT projects, streamline development workflows, and automate deployments. For full usage, consult the extensive online documentation.

CAVEATS

Requires an active internet connection for most operations. Requires a balenaCloud account. Some features depend on the specific balenaOS version running on the device.

DEVICE DEBUGGING

balenaCLI provides tools for remote debugging of applications running on devices, making it easier to identify and resolve issues in the field. This includes features like SSH access, log streaming, and remote shell execution.

APPLICATION MANAGEMENT

The tool allows for managing various aspects of an application, such as environment variables, device configuration, and release management. It offers granular control over application behavior and deployment strategies.

HISTORY

The balenaCLI was developed by balena.io to provide a streamlined interface for managing IoT application deployments to their platform. It builds upon existing containerization technologies and provides an intuitive command-line experience for both developers and operations teams.

SEE ALSO

docker(1), ssh(1)

Copied to clipboard