How to Use WorldJen

This page walks through installing and running the runner, creating a run, and navigating your way around the app.

Installing the runner

The runner runs on a machine with an NVIDIA GPU. Install the Python package with the runner extra, then register using a one-time token from the app.

1. Create a runner in the app — Go to Runners and click New Runner. You'll get a registration token and setup steps.

2. Install on your GPU machine — Install with pip or uv:

   pip install worldjen[runner]

   or uv pip install worldjen[runner]. Requires Python 3.10+ and Linux with systemd.

3. Register the runner — Before the token expires (about 10 minutes), run the command shown in the app, e.g.:

   worldjen runner register --token <YOUR_TOKEN>

   After this, the runner appears as online on the Runners page.

Starting and stopping the runner

After registration, install the systemd service and start the runner so it can accept work:

worldjen runner install   # installs the service (e.g. auto-start on boot)
worldjen runner start      # start now

To stop or view logs:

worldjen runner stop
worldjen runner logs -f

Viewing runner logs

worldjen runner logs shows recent logs; worldjen runner logs -f streams them (follow mode).

Creating a run

1. Dashboard → Click "+ New run".
2. Choose a runner — Pick an online runner or create one.
3. Configure the model — Select or add a model (e.g. Hugging Face repo); add credentials if needed.
4. Choose dimensions — Pick a preset or select individual dimensions.
5. Model Comparison — Add optional reference runs and models.
6. Launch — Start the run.

Navigating the application

• Dashboard — List of runs (status, model, timestamps). Open a run to see results.
• Runners — Add runners, copy install/register/start commands, see status.
• Models — Manage model configurations.
• Run page — Summary, Gallery (videos and scores), Logs, and actions (Cancel, Duplicate, Export).
• Settings — User and preference settings.

Quick reference: runner commands

Action	Command
Install package (pip)	pip install worldjen[runner]
Install package (uv)	uv pip install worldjen[runner]
Register (one-time per runner)	worldjen runner register --token <token>
Install systemd service	worldjen runner install
Start service	worldjen runner start
Stop service	worldjen runner stop
View logs	worldjen runner logs
Stream logs	worldjen runner logs -f