Transformer Lab CLI
Transformer Lab can be accessed via CLI using the lab executable.
Global Options​
lab [OPTIONS] COMMAND [ARGS]...
| Option | Description | Default |
|---|---|---|
--format | Output format: pretty or json | pretty |
--help | Show help message and exit |
Commands​
version​
Display the CLI version.
lab version
status​
Check the status of the server and configuration.
lab status
login​
Log in to Transformer Lab. Prompts for server URL and API key if not provided.
# Interactive login (prompts for server and API key)
lab login
# Login with options
lab login --server https://my-server:8338 --api-key YOUR_API_KEY
| Option | Description |
|---|---|
--api-key | Your API key |
--server | Server URL |
logout​
Log out from Transformer Lab by deleting the stored API key.
lab logout
whoami​
Show the current logged-in user, team information, and server.
lab whoami
# JSON output
lab --format json whoami
config​
View or set configuration values.
# View all configuration values
lab config
# Set a configuration value
lab config <key> <value>
# Examples
lab config server http://localhost:8000
lab config current_experiment my_experiment
| Argument | Description |
|---|---|
key | Config key to set |
value | Config value to set |
task​
Task management commands. Requires current_experiment to be set in config.
task list​
List all remote tasks in the current experiment.
lab task list
task add​
Add a new task from a local directory or a Git repository.
# Add from a local directory containing task.yaml
lab task add ./my-task-directory
# Preview without creating (dry run)
lab task add ./my-task-directory --dry-run
# Add from a Git repository
lab task add --from-git https://github.com/user/repo
| Argument | Description |
|---|---|
task_directory | Path to the task directory containing task.yaml |
| Option | Description |
|---|---|
--from-git | Git URL to fetch the task from |
--dry-run | Preview the task without creating it |
task info​
Get detailed information for a specific task.
lab task info <task_id>
task delete​
Delete a task by ID.
lab task delete <task_id>
task queue​
Queue a task on a compute provider. Interactively prompts for provider selection and parameter values.
# Interactive mode (prompts for provider and parameters)
lab task queue <task_id>
# Non-interactive mode (uses defaults)
lab task queue <task_id> --no-interactive
| Option | Description |
|---|---|
--no-interactive | Skip interactive prompts and use defaults |
job​
Job management commands. Most subcommands require current_experiment to be set in config.
job list​
List all jobs for the current experiment.
lab job list
job info​
Get detailed information for a specific job.
lab job info <job_id>
job artifacts​
List artifacts for a specific job.
lab job artifacts <job_id>
job download​
Download all artifacts for a job as a zip file.
# Download to current directory
lab job download <job_id>
# Download to a specific directory
lab job download <job_id> --output ./downloads
| Option | Description |
|---|---|
-o, --output | Output directory for the zip file (default: current directory) |
job monitor​
Launch the interactive job monitor TUI.
lab job monitor