Setup
Overview
The tvlabs
CLI is a command-line tool to interact with the TV Labs platform. It provides a simple and secure way for developers and support teams to access devices within the TV Labs fleet for development, troubleshooting, as well as integration with CI/CD workflows.
Supported Platforms
The CLI currently supports the following platforms:
- Tizen
- webOS
- Android TV
- Fire TV
- Google TV
- Roku
Installation
- Linux / macOS
- Windows
To install the TV Labs CLI, use the following command:
/bin/bash -c "$(curl -fsSL https://tvlabs.ai/install.sh)"
To update to the most recent version, use the same command.
Verify your installation by running the following command in your shell:
tvlabs --version
On Windows, there are multiple ways to install the TV Labs CLI. Windows support is experimental, please reach out to TV Labs support if there are issues.
Unix-like Environment (Cygwin / MSYS / WSL)
To install the TV Labs CLI, use the following command:
/bin/bash -c "$(curl -fsSL https://tvlabs.ai/install.sh)"
To update to the most recent version, use the same command.
Verify your installation by running the following command in your shell:
tvlabs --version
If using Cygwin, ensure the latest version of curl
is installed via the Cygwin installer. The version of curl
that ships with Cygwin by default is outdated and may cause issues when running the installation script.
Manual Installation
The CLI can be manually installed on Windows metal by downloading the appropriate binary. In the future, this process will be streamlined.
Move the downloaded binary to C:\Users\<username>\.tvlabs\bin\tvlabs.exe
, and add it to your system PATH:
setx PATH "%PATH%;C:\Users\<username>\.tvlabs\bin"
Verify your installation by running the following command in your shell:
tvlabs --version
If installed manually, the instructions provided by tvlabs upgrade
will not work to upgrade the CLI. Please download the latest version from this page and replace the old binary.
Authentication
Go to https://tvlabs.ai/app/keys to create a new API key:
Figure 1: Creating an API key. You can give the key any name.
Figure 2: List of API keys.
To authenticate with the TV Labs platform, use the auth
command followed by the just created API key:
tvlabs auth tv-XyODphpNhwdAphR6rIKINxLXVWGi_dby5rRHWWahDz6
Note: Treat your API key as a password. Always keep it secure.