CLI commands

Overview of Tessl's tools for creating, editing, and managing specs.

Tools are functions that take in a set of parameters and execute a task on your specs. They perform specific actions on your specs, from searching to installing usages specs. This page provides a comprehensive reference for all Tessl tools.

Getting started

tessl help

To see all available tools and commands, you can run:

tessl --help

To get detailed information about a specific tool, use the --help flag with that tool:

tessl <tool-name> --help

---

Usage Specs

tessl registry install

Install usage specs into your project

Usage

tessl registry install <name>

Parameters

• name (string): The full name of the package e.g. "tessl/[email protected]". The version (e.g. '@5.38.0') is optional; if omitted, the latest version will be used.

Examples

# Install the tessl usage spec for svelte version 5.38.0
tessl registry install tessl/[email protected]

tessl registry search

Search Tessl's Spec Registry for usage specs, by name, package-url, or package registry web url

Usage

tessl registry search <name>

Parameters

• name (string): A name, package-url, or package registry web url

Examples

# Search for usage specs for svelte
tessl registry search svelte

tessl registry sync

Finds and installs Tiles for the dependencies declared in your project. Tessl uses your package manager to add the appropriate Tiles and updates tessl.json accordingly. If newer versions of Tiles are available, they will also be updated.

Ecosystems supported:

• JavaScript: yarn, npm, pnpm

• Java: maven, gradle

• Python: pip, poetry

Usage

tessl registry sync

tessl registry publish

Publish specs to the Tessl registry

Usage

tessl registry publish <path>

Parameters

• path (string): Path to the tile directory to publish

Examples

# Publish a tile to the registry
tessl registry publish path/to/my/tile

---

Authentication commands

tessl login

Login to Tessl. We currently support Github and Google as an identity provider

tessl whoami

Show Tessl authentication status and email + tessl-user-id

tessl logout

Logout from Tessl

Setup commands

tessl setup agent

See Guided setup

Note: The setup language command has been removed in v0.19.0. Tools that require test commands now use a --test-command flag instead.

Workspace Management

You can create private workspaces that enable you to store and retrieve usage specs that you want to restrict only to yourself or your organization. You can control the members who would have access and the specific permissions for each of them. To learn more, see Publish private usage specs for your libraries.

tessl workspace list

List all workspaces

tessl workspace list

tessl workspace create

Create a new workspace

Parameters

• name (string): Name for the workspace. The name must be lowercase.

tessl workspace create <name>

tessl workspace delete

Delete an existing workspace

Parameters

• name (string): Name of the workspace

tessl workspace delete <name>

tessl workspace list-members

List all members of a workspace

Parameters

• name (string): Name of the workspace

tessl workspace list-members <name>

tessl workspace add-member

Add a member to a workspace.

Parameters

• --workspace (string): Name of the workspace

• --user (string): The username or ID of the user to add

• --role (string): viewer (install), member (install, publish) or owner (install, publish, archive, unpublish)

tessl workspace add-member --workspace <name> --user <username-or-id> --role [viewer|member|owner]

tessl workspace remove-member

Remove a member from a workspace

Parameters

• --workspace (string): Name of the workspace

• --user (string): The username or ID of the user to remove

tessl workspace remove-member --workspace <name> --user <username-or-id>

Exit codes

The codebase follows a consistent pattern:

• 0 (SUCCESS) - All operations completed successfully

• 1 (FAILURE) - Standard error/failure condition

• 144 - Critical startup/initialization error

• 145 - Legal/terms acceptance required