Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Run FLUX

This section provides instructions on how to run FLUX and introduces some notable command-line options available to customize its operation.

To start FLUX after installation:

flux run

Specifying a Block Range

  • Start Block: The block number from which FLUX begins processing (inclusive). If omitted, FLUX will run at tip until manually stopped, provided you have access to the db API.
  • End Block: The block number at which FLUX stops processing (exclusive). If omitted, FLUX will run historically and continue at the tip until manually stopped, provided you have access to the db API.
flux run --start-block 1234567 --end-block 2345678

You can also specify multiple block ranges to be run in parallel by using the --ranges flag:

flux run --ranges 100-120 750-900 3000-5000

Notable Parameters

  • Quote Asset Address: This sets the asset used to denominate values in the analysis. The default is USDT (Tether) and we recommend sticking to it. To change the default, use:
flux run ... --quote-asset [ASSET_ADDRESS]

Note

For a complete list of command-line interface (CLI) options refer to the CLI reference section in the documentation.