ThingsBoard CLI

CLI tool for managing ThingsBoard resources from the terminal.

Installation

Install uv if you don't have it:

curl -LsSf https://astral.sh/uv/install.sh | sh

Then install the CLI:

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 --help
tb config set --url https://thingsboard.cloud --api-key YOUR_KEY
tb device list

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.