For the complete documentation index, see llms.txt. This page is also available as Markdown.

Installation

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

Install

1

Download the CLI

The CLI can be installed using Curl (native), Homebrew or npm (deprecated).

curl -fsSL https://get.tessl.io | sh
brew tap tesslio/tap #  Recommended as of Homebrew 6.0.0
brew trust tesslio/tap #  Recommended as of Homebrew 6.0.0
brew install tesslio/tap/tessl
winget install tessl.tessl
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 your organization uses the EU region, follow Using the EU region before you log in. Set the EU environment in your shell and use device login as described there.

$ TESSL_ENV=app-eu tessl login --device

For organizations in other regions, 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

Automatic Updates

The Tessl CLI automatically checks for updates and installs them in the background. Updates run silently without interrupting your workflow.

  • Updates check every 3 hours by default

  • Updates only occur when you run CLI commands; they might briefly delay command exit

  • To disable automatic updates, set TESSL_AUTO_UPDATE_INTERVAL_MINUTES=0

  • Update logs are saved to ~/.tessl/auto-update.log for troubleshooting

Automatic updates are disabled in CI environments and on winget

Manual Update

To manually update your CLI to the latest version:

tessl cli update

This command will update your CLI to the latest version for your current release channel.

tessl cli update

This command will update your CLI to the latest version for your current release channel.

winget upgrade tessl.tessl

Running tessl cli update will provide a hint to use winget upgrade tessl.tessl instead

npm update -g @tessl/cli

Update to Specific Version

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

Example to update to a specific version:

Installing a specific version is not supported in brew. To update to a specific version execute:

Example to update to a specific version:

Running tessl cli update will provide a hint to use winget upgrade tessl.tessl instead

Example to install a specific version:

Uninstall

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

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

Determine which npm Tessl package you have:

To uninstall @tessl/cli

To uninstall tessl

Remove the native binaries:

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

Last updated