Skip to content

CLI Reference

Detailed overview of the Command Line Interface (CLI). See Workflow and CLI Usage for the overall sequence.

General Usage

1
lst-tools [options] <subcommand> [<args>]

Global options:

1
2
3
4
5
lst-tools --help
lst-tools -V
lst-tools --version
lst-tools --verbose
lst-tools --debug

Some options also provide shorthand forms. For example, -V and --version both print the installed version.

Show top-level help:

1
lst-tools --help

Show version:

1
2
lst-tools -V
lst-tools --version

Get help for any subcommand:

1
lst-tools <subcommand> --help

Global options such as --verbose/-v and --debug/-d apply to the command groups and subcommands below.

Option Precedence

When a command supports both lst.cfg values and explicit CLI options, use this rule:

  1. Load defaults from lst.cfg.
  2. Apply explicit CLI options for the current invocation.
  3. Keep the CLI override local unless the command explicitly writes values back to the config.

Practical implications:

  • --cfg changes which config file is loaded; it does not override one field.
  • Output-path options such as --out and --name affect the current run only.
  • setup parsing --auto-fill and setup tracking --auto-fill can write derived values back into lst.cfg when a config path is available.
  • Processing commands use config values as defaults, but explicit CLI flags such as --interpolate take precedence for that run.
  • Selector flags such as --maxima, --volume, --animate, or --branches choose which actions run; they do not rewrite config values.

Subcommands

lst-tools init

Command Purpose
init Create or seed lst.cfg

lst-tools lastrac

Command Purpose
lastrac Convert HDF5 base flow to meanflow.bin

lst-tools setup

Subcommand Purpose
parsing Write the broad parsing input deck
tracking Build tracking case directories and decks
spectra Write fixed-station spectra decks

lst-tools process

Subcommand Purpose
tracking Post-process tracking results
spectra Post-process spectra results

lst-tools visualize

Subcommand Purpose
parsing Render quick preview PNGs from parsing output
tracking Render quick preview PNGs from tracking output

lst-tools clean

Subcommand Purpose
parsing Remove parsing artifacts
tracking Remove tracking artifacts
spectra Remove spectra artifacts

Utility Commands

Command Purpose
hpc Generate or regenerate a run script
info Inspect meanflow.bin metadata