CLI Reference

CLI Reference

Commands

Command	Description
`run`	Execute a strategy backtest
`seek`	Optimise strategy inputs
`strategies`	List available strategies
`symbols`	List available symbols
`cache`	Manage the data cache
`portfolio`	Analyse trade export files
`index`	Generate a portfolio index page
`version`	Show version information
`shell`	Launch the interactive shell (default when no command given)

Global flags

Flag	Description
`--help`	Display help
`--verbose`	Enable verbose output
`--profile <path>`	Save profiler output

`run` flags

Strategy and data

Flag	Default	Description
`--strategy <name>`		Strategy to run
`--symbols <list>`		Symbols (comma/slash-separated, or `<portfolio`)
`--symbols-exclude <list>`		Symbols to exclude
`--config <file>`		JSON configuration file
`--inputs <list>`		Override inputs (e.g., `Period=20,Mult=2.0`)

Date range

Flag	Default	Description
`--date-from`	`2010-01-01`	Start date
`--date-to`	Today	End date
`--use-first <N>`		Use first N% of data
`--use-last <N>`		Use last N% of data

Bar configuration

Flag	Default	Description
`--bar-interval`	`daily`	Bar size
`--bar-building-mode`	`natural`	`natural` or `session`
`--max-bars-back`	`263`	Maximum lookback
`--no-look-inside-bar`	`false`	Disable intra-bar evaluation
`--bouncing-ticks`	`0`	Bouncing ticks percentage (0-100)

Session

Flag	Default	Description
`--session-hours`	Symbol default	Trading hours
`--session-days`	Symbol default	Trading days
`--timezone`	Exchange TZ	IANA timezone
`--no-out-of-session-execution`	`false`	Disable shadow bars

Cost model

Flag	Default	Description
`--slippage-mode`	`per-unit`	`per-unit` or `per-trade`
`--slippage-ticks`	`0`	Slippage in ticks
`--commission-mode`	`per-unit`	`per-unit`, `per-trade`, or `percentage`
`--commission-amount`	`0`	Commission amount
`--commission-percentage`	`0`	Commission percentage

Capital and direction

Flag	Default	Description
`--initial-capital`	`1000000`	Starting capital
`--position-size`	`1`	Default position size
`--risk-free-rate`	`0.04`	Risk-free rate
`--dir-long-only`	`false`	Long only
`--dir-short-only`	`false`	Short only
`--no-pyramiding`	`true`	Disable pyramiding

Output

Flag	Default	Description
`--output-mode`	`silent`	`summary`, `trades`, `graph`, `returns`, `config`, `all`, `silent`
`--combined-only`	`false`	Show only combined results for multi-symbol runs
`--export <path>`		Export trades to JSON
`--portfolio <path>`		Generate portfolio HTML
`--audit-trail <path>`		Save filter decision log

Execution

Flag	Default	Description
`--parallel <N>`	`64`	Number of parallel workers (0 = sequential)
`--execution-mode`	`auto`	`auto`, `parallel`, or `sequential`

Filtering

Flag	Description
`--filter <name>`	Apply a named filter (replaces config filters)
`--filter-inputs <params>`	Filter parameters (e.g., `max-positions=4`)
`--market-suitability <expr>`	Filter by market suitability rating

`seek` flags

Shares most flags with run, plus:

Flag	Default	Description
`--fitness-metric <expr>`	`npdd`	Metric to maximise
`--opt-mode <mode>`	`exhaustive`	`exhaustive` or `genetic`
`--inputs-include <list>`		Only optimise these inputs
`--inputs-exclude <list>`		Exclude these inputs
`--nbr-threads <N>`	`24`	Optimisation threads

`strategies` flags

Flag	Description
`-l`	Long format with descriptions
`-i`	Show inputs with types and defaults
`-t`	Sort by modification time
`-1`	One entry per line
`-r`	Reverse sort order

`symbols` flags

Flag	Description
`-l`	Long format
`-1`	One per line
`-t, --asset <type>`	Filter by asset type
`-x, --exchange <name>`	Filter by exchange
`-c, --category <name>`	Filter by category
`-y, --country <code>`	Filter by country
`-d, --description <regex>`	Search descriptions
`-s, --sort <field>`	Sort field
`-r`	Reverse sort
`-C, --no-cot-sub`	Exclude COT subcategories

`cache` flags

Flag	Description
`-l, --list`	List cached entries
`-F, --flush`	Clear cache (supports patterns)
`-s, --stats`	Show statistics
`-I, --index`	Rebuild index

`config` flags

Flag	Description
`-f, --file`	Path to the configuration file

The algo config command validates a configuration file and displays the parsed settings as formatted JSON. This is useful for checking that your config is valid before running a backtest.

`portfolio` flags

Flag	Default	Description
`-o, --output`	`portfolio.html`	Output file path
`-d, --description`		Portfolio subtitle

`index` flags

Flag	Default	Description
`-o, --output`	`index.html`	Output file path

RunState API Reference