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). Tessl framework is in private beta. Join our community to be updated on our future product releases.

Install

1

Download the CLI

The CLI can be installed using npm .

Note: the Tessl CLI requires 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

npm update -g @tessl/cli

Update to specific version

  • You can find all the releases npm info @tessl/cli

  • To install/upgrade to a specific version

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

Example to install the specific version, v0.21.0

npm install -g @tessl/[email protected]

Uninstall

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

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

Last updated