Skip to content
GitHub
View on GitHub

CLI Reference

Command-line interface for the Training Gym SDK.

The training-gym CLI is installed automatically with the package.

Terminal window
pip install git+https://github.com/modal-projects/training-gym.git@main

Deploy the observability dashboard to your Modal account.

Terminal window
training-gym setup

This is equivalent to calling setup() from Python:

import modal_training_gym
modal_training_gym.setup()

The command builds a Modal image (Node.js + Svelte frontend + FastAPI backend), deploys it as a persistent web app, and prints the dashboard URL.

Prerequisites: a Modal account with modal token set already configured.

usage: training-gym [-h] {setup} ...
positional arguments:
{setup}
setup Deploy the training-gym dashboard to Modal
options:
-h, --help show this help message and exit