The sf CLI

Every command, grouped by what you are trying to do.

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

sf is the whole client. It creates the project, validates configs locally, packages and submits jobs, follows logs, and manages datasets, models, plugins and environments.

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 sf --help prints.

Set up

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

Experiments

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

Train

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

Artifacts and evaluation

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

Resources

Command	What it does
sf dataset	Prepare, check, push and version datasets
sf model	The model registry: register, promote, archive
sf env	Agent RL environments: list, push, inspect, register a runner
sf annotate	Preference annotation: pull, push, progress
sf plugin	Publish, install and inspect plugins

Administration

Command	What it does
sf admin	Users, roles, quotas, maintenance windows

Conventions

• -h / --help works everywhere. sf job logs --help is faster than finding the page.
• The project root is found by starforge.yaml. Run commands from anywhere inside the project.
• State lives in ~/.forge/ — the access token and the server address. Nothing else.
• Job commands default to your most recent job. sf job logs with no id follows the latest one.
• References are <owner>/<name>, with @version where versions exist: alice/gsm8k-zh@v2.

Shell completion

sf --install-completion

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