CLI Reference
Every tren command, condensed. For full flag-by-flag detail, see docs/command-reference.md in the repo.
tren setup
First-time environment setup: virtual environment, toolchain (NumPy, Jupyter, Jupytext, nbdev, Rich, PyYAML, psutil), Jupyter kernel registration, local profile.
| Flag | Purpose |
|---|
--skip-venv | Skip virtual environment creation |
--skip-packages | Skip package installation |
--skip-profile | Skip local profile creation |
--force | Recreate existing components instead of reusing them |
tren system
| Subcommand | Purpose |
|---|
info | Environment info (Python version, platform, venv, TrenTorch/NumPy versions, disk/memory). --json |
health | Quick status-only health check |
jupyter | Start a Jupyter server. --notebook/--lab, --port N |
update | Check for and install a newer release |
logo | The TrenTorch logo, explained |
reset | Reset to a pristine state. --force/-f, --keep-progress, --ci |
tren module: the primary student workflow
| Subcommand | Purpose |
|---|
start NN | Start a module for the first time, opens Jupyter. --no-jupyter |
view NN | Open a module's notebook with no status updates |
resume [NN] | Continue working (defaults to last-worked module) |
complete [NN] | The one that matters. Tests, exports to the real package, updates progress. --skip-tests, --skip-export, --all |
test [NN] | Same testing as complete, without exporting. --all, --stop-on-fail, --unit-only, --no-integration |
reset [NN] | Reset a module (or --all) to a clean state |
status | Progress across all modules |
list | All available modules. --json |
path NN | A specific file path for IDE integration: --notebook, --source, or --guide |
tren dev: maintainer/CI tooling, not for students
| Subcommand | Purpose |
|---|
test | The unified test runner. --unit, --integration, --e2e, --cli, --inline, --milestone, --user-journey/--release, --all; --module N; --ci for JSON + strict exit codes |
preflight | Pre-release verification. --quick (~10s), --full (~2-5min), --release (~10-30min) |
export | Rebuild the curriculum from data/src/*.py: notebooks + the real package, from the reference solutions. --all or specific module names |
clean | make clean at the project root |
tren package
| Subcommand | Purpose |
|---|
reset {package,all,progress,milestones,config} | Reset specific pieces of state |
nbdev --export/--build-docs/--test/--clean | Direct nbdev operations |
tren milestone
| Subcommand | Purpose |
|---|
list | Available milestones and status. --simple |
run ID | Run a milestone (checks prerequisites first). --part N, --skip-checks |
info ID | Details on one milestone |
status | Progress and achievements. --detailed |
timeline | The historical arc as a tree or --horizontal progress bar |
test [ID] | Test milestone requirements |
demo ID | Run a capability demonstration |
ID accepts either the number (04) or an alias (perceptron, xor, mlp, cnn, transformer, mlperf).
tren benchmark
| Subcommand | Purpose |
|---|
baseline | Lightweight setup-validation benchmark, scored against a reference system out of 100 |
capstone | Full Module 20 performance evaluation. --track {speed,compression,accuracy,efficiency,all} |
tren olympics
Competition events, currently a "coming soon" placeholder (logo, status).
Global options
--version, --verbose/-v, --no-color: apply to tren itself, before any subcommand.