zfin/docs/reference/cli/perf.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.5 KiB

zfin perf

Show Morningstar-style trailing returns for a symbol.

Usage: zfin perf <SYMBOL>

perf prints 1Y/3Y/5Y/10Y price-only and total-return CAGR plus risk metrics (Sharpe, max drawdown, volatility), in two tables: an as-of table (through the latest cached close) and a month-end table (through the most recent calendar month-end, the way funds quote their stats). Total returns require POLYGON_API_KEY for dividend history; price-only returns work without it.

Example

ZFIN_HOME=examples/pre-retirement-both zfin perf VTI
Trailing Returns for VTI
========================================
Data points: 6290 (2001-05-31 to 2026-06-04)
Latest close: $373.38

As-of 2026-06-04:
                           Price Only   Total Return
---------------------- -------------- --------------
  1-Year Return:              27.29%        28.79%
  3-Year Return:              20.75%        22.22%  ann.
  5-Year Return:              11.22%        12.80%  ann.
  10-Year Return:             13.19%        15.10%  ann.

Month-end (2026-05-31):
  ... (same shape, through last month-end)

Risk Metrics (monthly returns):
                           Volatility         Sharpe         Max DD
  1-Year:                      12.7%          1.65          5.5%

See also


CLI command reference