The tp CLI - TunePlane

uv tool install tuneplane     # or: pip install tuneplane
tp login --server https://tuneplane.your-company.com
tp status
tp update    # later, to upgrade

One command does all of it: create the project, validate configs locally, pack and submit jobs, follow logs, and manage datasets, volumes, models, plugins and environments. The entry point installs under both names, tuneplane and tp. Every page here writes tp.

Every flag table on these pages is generated from the CLI itself by scripts/gen_cli_docs.py, and CI fails if it drifts. What you read here is what tp --help prints.

Set up

Command	What it does
`tp init`	Create a TunePlane project
`tp login`	Log in to a deployment
`tp logout`	Log out
`tp status`	Your account, quota, and active jobs
`tp update`	Update `tuneplane` itself
`tp version`	Version of the CLI, and of the server it talks to

Experiments

Command	What it does
`tp new`	Create an experiment from a method template
`tp ls`	List the experiments in this project
`tp validate`	Check a config against the method declaration, locally
`tp methods`	The method catalog, and one method’s tunable parameters
`tp recipe`	Inspect and upgrade an experiment’s recipe lock

Train

Command	What it does
`tp submit`	Submit a training job
`tp sweep`	Submit a grid of variants
`tp job`	Logs, status, samples, pause, resume, stop
`tp clean`	Delete an experiment’s checkpoints and logs

Artifacts and evaluation

Command	What it does
`tp export`	Convert a checkpoint to HuggingFace format
`tp eval`	Run a recipe’s native evaluation
`tp bench`	Run standard benchmarks
`tp serve`	Start, extend and stop Playground sessions

Resources

Command	What it does
`tp dataset`	Prepare, check, push and version datasets
`tp volume`	Governed directories a job mounts read-only
`tp model`	The model registry: register, promote, archive
`tp env`	Agent RL environments: list, push, inspect, register a runner
`tp annotate`	Preference annotation: pull, push, progress
`tp plugin`	Publish, install and inspect plugins

Administration

Command	What it does
`tp admin`	Users, roles, quotas, maintenance windows

Conventions

-h / --help works everywhere. tp job logs --help is faster than finding the page.
The project root is found by tuneplane.yaml. Run commands from anywhere inside the project.
State lives in ~/.tuneplane/ — the access token and the server address. Nothing else.
tp job logs defaults to your most recent job. The other job commands take an id.
References are <owner>/<name>, with @version where versions exist: alice/gsm8k-zh@v2. A Volume is the exception and never carries a version.

Shell completion

tp --install-completion

Installs completion for your current shell. --show-completion prints the script instead, if you would rather place it yourself.

​Set up

​Experiments

​Train

​Artifacts and evaluation

​Resources

​Administration

​Conventions

​Shell completion

Set up

Experiments

Train

Artifacts and evaluation

Resources

Administration

Conventions

Shell completion