ThingsBoard CLI

CLI tool for managing ThingsBoard resources from the terminal.

Installation

Run one command. It installs uv if it is missing, installs the CLI, and starts the guided setup:

# macOS and Linux
curl -LsSf https://thingsboard.io/cli/install.sh | sh

# Windows
powershell -ExecutionPolicy ByPass -c "irm https://thingsboard.io/cli/install.ps1 | iex"

Or install with uv yourself:

uv tool install thingsboard-cli

Upgrading

The CLI checks for updates automatically on launch and prompts to upgrade. You can also upgrade manually:

tb update

Shell Completion

# Bash
tb --install-completion bash

# Zsh
tb --install-completion zsh

# Fish
tb --install-completion fish

Restart your terminal after installing completion.

Usage

tb init my-project      # create a project, connect to ThingsBoard, and see the next steps
tb config               # connect to ThingsBoard (add --browser when an AI agent runs it)
tb device list
tb --help

Environment Variables

Variable	Purpose
`TB_URL`	ThingsBoard URL. Overrides the URL of the active profile.
`TB_API_KEY`	API key. Overrides the credentials of the active profile. Use it with `TB_URL` in CI.
`TB_PROFILE`	Name of the profile to use, the same as `--profile`.
`TB_CONFIG_HOME`	Folder for profiles and settings. Default: `~/.thingsboard`.
`TB_DEBUG`	Set to `1` to print every HTTP request and response, the same as `--debug`.

Example for CI:

TB_URL=https://thingsboard.cloud TB_API_KEY=$TB_API_KEY tb push my-solution

Verbose Help

Use -H or --help-verbose on any command to see detailed API documentation, JSON schemas, and field descriptions:

tb device create -H
tb dashboard save -H

Contributing

For local development setup, editable installs, regenerating help text, and publishing, see CONTRIBUTING.md.

Metadata

Release files for thingsboard-cli 4.4.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for thingsboard-cli 4.4.0.1
File	Size	Uploaded	Provenance
thingsboard_cli-4.4.0.1.tar.gz	37.7 MB	Oct 23, 2026	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for thingsboard-cli 4.4.0.1
File	Interpreter	ABI	Platform	Reset
thingsboard_cli-4.4.0.1-py3-none-any.whl 39.3 MB Oct 23, 2026 Without provenance	Python 3	none	any	Details

Total release size: 77.1 MB

Release files / thingsboard_cli-4.4.0.1.tar.gz

Download URL	thingsboard_cli-4.4.0.1.tar.gz
Size	37.7 MB
Tags	Source
SHA-256 checksum How to use checksums	`7e40647520cd2c9c6cf85f938c3b07120f9a56f5a7c27b00516919eec78a5d7a`
BLAKE2b-256 checksum How to use checksums	`394045853f8bde0b5635179290038023f0973b4f8ed1d83c2ab3c83d3e0e0ed1`
Upload date	Oct 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.14.3`

Release files / thingsboard_cli-4.4.0.1-py3-none-any.whl

Download URL	thingsboard_cli-4.4.0.1-py3-none-any.whl
Size	39.3 MB
Tags	Python 3
SHA-256 checksum How to use checksums	`1470a6c49ea3bba4848adee98ddafa69d27f0cdda20aa1ec27a0b6456c45319c`
BLAKE2b-256 checksum How to use checksums	`0c469e56ff3a4f5eae6a5e06074044116ddcdcf352a754d88cd7ad85d3a4ff2a`
Upload date	Oct 23, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.2.0 CPython/3.14.3`

Security for thingsboard-cli 4.4.0.1

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.