Skip to main content

Transformer Lab CLI

Transformer Lab can be accessed via CLI using the lab executable.

Installing the Transformer Lab CLI​

You can install the lab tool using uv.

Prerequisite: Ensure you have uv installed before running the command below.

uv tool install "git+https://github.com/transformerlab/transformerlab-app#subdirectory=cli"

Authentication​

To interact with your Transformer Lab instance, the CLI requires the following credentials:

  • Server URL: The URL of your API (e.g., https://app.lab.cloud). Include the port if not using 80/443.
  • Email: Your user email address.
  • API Key: Your access token.
Where to find your API Key

You can generate or view your API Key in the Transformer Lab GUI under User Settings.

Interactive Login​

The easiest way to set up your credentials is via the interactive prompt:

lab login

Non-Interactive Login​

For scripts or single-command setup, you can pass your credentials as flags:

lab login --apiKey <INSERT API KEY HERE> --serverURL https://app.lab.cloud:8338

Verifying Configuration​

To inspect your current configuration and ensure your credentials are saved correctly, run:

lab config

Tasks​

Listing Tasks​

You can list tasks by typing lab task list

Creating a Task​

Command documentation pending

Jobs​

Viewing the Status of a Job​

You can list jobs by typing lab job status

Monitoring Jobs​

For an interactive GUI to monitor jobs use lab job monitor