Installation

A step-by-step guide on how to install, update or remove the Tessl CLI.

👉 Closed beta notice

If you do not have access to the closed beta, you do not need to authenticate (step 3). The Tessl framework is currently part of Tessl’s closed beta program. You can request access here.

Install

1

Download the CLI

Option A: Using npm

The CLI can be installed using npm. Note: this does require a Node version 22.x or higher

npm install -g @tessl/cli

2

Test the CLI

Run the following command to check that everything is working.

tessl --help

3

Authenticate with Tessl [optional]

👉 If you are not enrolled in the closed beta program, please ignore this step.

Log in to Tessl to access all CLI functionality.

tessl login

• This will display a verification code and URL

Please log in at the URL below (if your browser didn't open automatically):

  https://auth.tessl.io/device

Then confirm the following code:

  XYZA-BCDE

⠏ Waiting for confirmation…

• Open the URL in your browser and login to Tessl with either your Github or Google account.

• Once authenticated, you can enter the device code in your browser window.

You can now verify your authentication status with:

tessl whoami

To log out when needed:

tessl logout

Upgrade

To upgrade your existing CLI to the latest version

Auto-update command (Recommended)

tessl update

This command will automatically update your CLI to the latest version.

Manual upgrade

To upgrade manually, you can re-run the same installation method you used before:

1. To determine your installation method, run:

   which tessl

   • If you see /usr/local/bin/tessl, you used our curl install script (Option B)

   • Otherwise, you used npm (Option A)

2. Re-run the corresponding installation command from the options above

3. Verify the update worked by checking your version:

tessl version

Update to specific version

• You can find all the releases via https://install.tessl.io/metadata/releases.txt

• To install/upgrade to a specific version

You can find all the releases in the changelog. To install/upgrade to a specific version

Using tessl update

Example to install the specific version, v0.19.0

tessl update -t v0.19.0

Using npm

Example to install the specific version, v0.19.0

npm install -g https://install.tessl.io/releases/v0.19.0.tgz

Using curl

# now run the curl installer - specify the version directly in the script
curl https://install.tessl.io/scripts/v0.19.0.sh | bash

Uninstall

Npm uninstall

• To uninstall the Tessl CLI, run npm uninstall -g tessl

• To remove Tessl config files, delete the ~/.tessl directory

Curl uninstall

If you used curl to install Tessl, you can remove the tessl CLI and Tessl config by deleting the directory ~/.tessl