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.
1 maintainer
Metadata
1 maintainer
Release files for thingsboard-cli 4.4.0.1.post1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| thingsboard_cli-4.4.0.1.post1.tar.gz | 37.8 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| thingsboard_cli-4.4.0.1.post1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 77.1 MB
Release files / thingsboard_cli-4.4.0.1.post1.tar.gz
| Download URL | thingsboard_cli-4.4.0.1.post1.tar.gz |
|---|---|
| Size | 37.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c42ac52a3cf5c50075a16a525338a1902dab4a3c37fd22fe6d3c9ea1437f64cd
|
|
BLAKE2b-256 checksum How to use checksums |
0f994734fa9ad777234a4485f5fdbb8fac556eb6a1b8e0c46e2a9388f791643b
|
| Upload date | |
|
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.post1-py3-none-any.whl
| Download URL | thingsboard_cli-4.4.0.1.post1-py3-none-any.whl |
|---|---|
| Size | 39.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fccd192446537defd58707f4c495ece0ee96ee337a0cbf77d3a90321cb306685
|
|
BLAKE2b-256 checksum How to use checksums |
38eb2f60fefb71db53b6d426f34307e2676e5dbcfbf429ae3b369e87f5c832f1
|
| Upload date | |
|
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.post1
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.
