CLI Overview

Run the CLI with a strategy TOML file, then add command-line options.

whale-e <strategy.toml> [options]

Global options#

• --help prints the usage summary.
• --version prints the version number.
• --update forces an update check before execution.
• --no-update disables the update check for that run.

--update and --no-update cannot be used together.

Execution modes#

Without an explicit mode flag, a full backtest is run and the outputs configured by your strategy and runtime configuration are produced.

• Analyze (dry run) validates the strategy, prepares grids, and computes combinations without downloading prices or running a backtest.
• Symbol Search finds supported symbols from exchange market lists before running a strategy.
• JSON Export writes structured results to stdout for automation workflows.
• Pine Script Export generates the Pine Script corresponding to a GxCy combination code.

Notes#

The CLI rejects some option combinations to keep behaviour explicit and predictable.

• --export-pinescript cannot be combined with --json.
• --analyze cannot be combined with --export-pinescript.
• --search-symbol is standalone and cannot be combined with a strategy file, --analyze, or --export-pinescript.
• In --analyze --json mode, --json-pretty is the only allowed JSON sub-option.
• In --search-symbol --json mode, --json-pretty is the only allowed JSON sub-option.
• JSON sub-options (--json-pretty, --json-objective-limit, --json-include-*) require --json.

For payload details, error formats, and concrete command examples, use the dedicated page for each mode.