zfin/docs/reference/cli/review.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

52 lines
2.3 KiB
Markdown

# `zfin review`
A per-holding performance and risk dashboard, with automated findings.
```
Usage: zfin review [opts]
```
One row per holding: sector, tax status, trailing returns
(1Y/3Y/5Y/10Y month-end total return), risk metrics (3Y+10Y
volatility/Sharpe, 5Y max drawdown), and a correlation-aware totals
row. A findings section flags concentration, sector dominance,
volatility outliers, and tiny positions. Reads
[`metadata.srf`](../config/metadata-srf.md) and
[`accounts.srf`](../config/accounts-srf.md).
## Options
| Flag | Effect |
|-----------------|------------------------------------------------------------------------------------------------------------------------------|
| `--sort FIELD` | Sort by `sector`, `symbol`, `weight`, `tax`, `1y`/`3y`/`5y`/`10y`, `3y-vol`/`10y-vol`, `3y-sharpe`/`10y-sharpe`, `5y-maxdd`. |
| `--asc` | Sort ascending (default is descending for numeric fields). |
| `--checks=MODE` | Findings engine: `all` (default), `fast` (skip long checks), `none`. |
| `--show-acked` | Include already-acknowledged findings. |
Default sort groups by sector, then weight descending within each.
## Example
```bash
ZFIN_HOME=examples/pre-retirement-both zfin review
```
```
Symbol Sector Wt% 1Y 3Y ... 3Y-SR 5Y-MaxDD Tax%
VTI Diversified 66.9% +30.2% +23.3% ... 1.29 24.8% 10.9%
QQQ Technology 3.5% +43.1% +29.3% ... 1.41 32.6% 0.0%
Findings (2 active, 0 acked, 0 resolved)
⚠️ VTI at 66.9% of liquid (warn at 50.0%, flag at 70.0%)
❌️ Diversified sector at 85.7% (warn at 60.0%, flag at 75.0%)
```
## See also
- [Read your portfolio](../../guides/read-your-portfolio.md#review-per-holding-performance-and-risk)
- [Returns and performance](../../explanation/returns-and-performance.md) -- the metric definitions.
- [`analysis`](analysis.md) -- portfolio-level breakdowns.
---
[CLI command reference](index.md)