zfin/docs/reference/cli/interactive.md
Emil Lerch 74fc219afd
All checks were successful
Generic zig build / build (push) Successful in 5m48s
Generic zig build / publish-macos (push) Successful in 11s
Generic zig build / deploy (push) Successful in 23s
add docs/guides
2026-06-22 14:53:53 -07:00

1.9 KiB

zfin interactive

Launch the interactive, multi-tab terminal UI.

Usage: zfin interactive [options]
Alias: zfin i [options]

The TUI is a vaxis-rendered interface for browsing your portfolio, per-symbol data, options chains, earnings, and projections. Press ? inside it for the keybinding overlay, and q (or Ctrl-C) to quit. With no portfolio or symbol given, it auto-loads portfolio.srf and opens on the Portfolio tab.

Options

Flag Effect
-s, --symbol <SYMBOL> Pre-load a symbol and open on the Quote tab.
--chart <MODE> Chart graphics: auto, braille, or WxH (e.g. 80x24). auto uses Kitty graphics if the terminal supports it, else braille.
--default-keys Print the default keybindings as a keys.srf template and exit.
--default-theme Print the default theme as a theme.srf template and exit.

The global flags (--no-color, -p, -w, --refresh-data=<value>) are honored.

Examples

ZFIN_HOME=examples/pre-retirement-both zfin i
zfin i -s AAPL                                   # open on a symbol, no portfolio
zfin i --default-keys > ~/.config/zfin/keys.srf  # generate a keybinding template

See also


CLI command reference