FlowscopeDocs

Settings

Environment variables, preferences and built-in defaults.

Most of Flowscope is configured in the interface and saved with your layouts and preferences. A few switches are environment variables, read once at start.

Environment variables

All of these apply to the desktop app. The browser build reads none of them; it only looks for sim and hub in the page’s query string (see History and data).

VariableValuesEffect
FLOWSCOPE_SIMAny valueRun on the built-in simulator instead of live data
FLOWSCOPE_PRESETorderflow, liquidity, venues, stress, flowStart from this preset instead of the saved layout
FLOWSCOPE_PERFAny valueOpen the performance overlay at start
FLOWSCOPE_OPENsearch, indicators, interval, objectsOpen symbol search, the indicator dialog, the custom interval dialog or the object tree at start
FLOWSCOPE_TOOLtrend, fib, longStart with the trend line, Fib retracement or long position tool
FLOWSCOPE_HUB_URLA URL, for example http://127.0.0.1:8790Take every market and its history from this data hub. Unset: the hub the app was built with, if any. Empty: no hub, and so no market data.
FLOWSCOPE_HUB_KEYA keyThe key shown to the hub, if it asks for one
FLOWSCOPE_TZ_OFFSETMinutes east of UTC, for example 120 or -300Override the machine’s offset for the Local time zone
RUST_LOGA log filter, for example info or flowscope_engine=debugLog level. The desktop defaults to warn.
Warning

Variables marked “any value” only check that the variable is set. FLOWSCOPE_SIM=0 still starts the simulator. Unset the variable to turn the switch off.

Presets

FLOWSCOPE_PRESETPreset
orderflowOrderflow desk
liquidityLiquidity
venuesBTC on every venue
stress60 charts (load test)
flowFlow studies: a developer layout with every flow study, not offered in the menu

See Layouts for what each preset contains. A preset from the environment is shown instead of the restored layout. The open layout keeps its name, and with autosave on, what is on screen is saved to it as usual.

Examples

Terminal
# Simulator with the performance overlay
FLOWSCOPE_SIM=1 FLOWSCOPE_PERF=1 ./target/release/flowscope

# Live, every market and its history from a hub on another machine
FLOWSCOPE_HUB_URL=https://hub.example.com ./target/release/flowscope

# Start from the Orderflow desk preset instead of the saved layout
FLOWSCOPE_PRESET=orderflow ./target/release/flowscope

Preferences

Preferences outlive layouts and apply everywhere. They are edited in the interface.

PreferenceWhere to change itDefault
Favourite intervalsStars in the interval menu1m, 5m, 15m, 1h, 4h, 1D
Custom intervalsAdd custom interval…None
Favourite chart typesStars in the chart type menuCandles, Footprint, Liquidity
Favourite studiesStars in the indicator dialogLiquidity Heatmap, CVD, Volume Profile, VWAP
Indicator templatesTemplates button in the top barNone
Time zoneClock in the bottom barUTC
AutosaveLayout menuOn
MagnetTool railOff
Stay in drawing modeTool railOff
Recent symbolsRemembered from symbol searchThe last 12
Crosshair sync across chartsSettings › General › ChartsOn
The crosshair of a linked chart stays in its link groupSettings › General › ChartsOff
Linked charts share drawingsSettings › General › ChartsOn
Theme: Dark, Midnight (blue-tinted), Graphite (lighter grey) or Black (OLED)Settings › General › Interface; applies at onceDark
Interface scaleSettings › General › Interface100 %

Time zones

The clock menu offers UTC, local time and fixed offsets: Los Angeles (UTC−8), New York (UTC−5), Berlin (UTC+1), Berlin summer (UTC+2), Dubai (UTC+4), Singapore (UTC+8) and Tokyo (UTC+9).

Fixed offsets do not follow daylight saving. Local time follows your machine and is re-read every minute. Trading sessions in profiles follow their own exchange clocks regardless of this setting.

Per-chart settings

Saved with the layout. See Charts.

SettingDefault
Chart typeDepends on the pane: candles, footprint or liquidity
Footprint cellsBid × Ask
Up, down and wick colours#22AB94 up, #F23645 down
Line colour#2962FF
Logarithmic scaleOff
Last price line, countdown to bar closeOn
GridOn
WatermarkOff
Legend: OHLC, indicator titles, indicator valuesOn

Ladder and depth book settings are listed in DOM and tape.

Built-in defaults

These are fixed in the engine today and not exposed as settings.

DefaultDesktopBrowser
Memory budget for markets3 GB768 MB
One-minute candles loaded at start3 days, from the data hub3 days, from the data hub
Raw tape seeded at startThe hub’s last 30 minutes of tradesSame
Footprint and heatmap historyWhat the hub recordedSame
Engine time per frame— (own threads)8 ms

Where settings are stored

WhatDesktopBrowser
Layouts, preferences, side panel<data dir>/flowscope/store/localStorage
Market historyNot stored: it comes from the data hub each sessionNot stored
Snapshots~/Pictures/flowscope-<seconds>.png, or your home folderClipboard only

See Layouts for the storage keys and History and data for what the app keeps on the machine.