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

64 lines
2.8 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# `zfin projections`
Retirement projections: percentile bands of your portfolio's projected
value, a benchmark comparison, and safe-withdrawal dollars at multiple
horizons and confidence levels.
```
Usage: zfin projections [opts]
```
Configuration lives in
[`projections.srf`](../config/projections-srf.md). What the output
shows (accumulation block, earliest-retirement grid, or drawdown-only)
depends on which inputs you set -- see
[Plan for retirement](../../guides/plan-retirement.md) and
[the model](../../explanation/projections-model.md).
## Sub-modes (mutually exclusive)
| Flag | View |
|---------------------|-----------------------------------------------------------------------|
| (default) | Percentile bands + benchmark + safe withdrawal. |
| `--vs <DATE>` | Side-by-side with a historical snapshot's projection. |
| `--convergence` | The model's predicted retirement date over time. |
| `--return-backtest` | Expected-return claim vs. realized forward CAGR (pair with `--real`). |
## Options
| Flag | Effect |
|-------------------------|-----------------------------------------------------------------------------------------|
| `--as-of <DATE>` | Project against a historical snapshot (auto-snaps to nearest earlier). |
| `--overlay-actuals` | Plot your realized trajectory from `--as-of` to today on the bands. Requires `--as-of`. |
| `--no-events` | Exclude life events (baseline view). |
| `--real` | With `--return-backtest`, render CPI-adjusted. |
| `--export-chart <PATH>` | Render the band chart to a 1920x1080 PNG and exit (default mode only). |
Dates accept `YYYY-MM-DD` or relative shortcuts (`1W`/`1M`/`1Q`/`1Y`).
## Example
```bash
ZFIN_HOME=examples/pre-retirement-both zfin projections
```
```
Accumulation phase:
Years until possible retirement: 19 (2046-04-12, ages 65/62)
Median portfolio at retirement: $7,871,732.10
Range (10th90th percentile): $5,807,693.45 to $18,240,675.15
Safe Withdrawal (FIRECalc historical simulation)
25 Year 35 Year 50 Year
99% safe withdrawal $314,920 $293,374 $264,002
```
## See also
- [Plan for retirement](../../guides/plan-retirement.md) -- the guided walkthrough.
- [`projections.srf` reference](../config/projections-srf.md) -- every input field.
- [The retirement projection model](../../explanation/projections-model.md) -- the method and caveats.
---
[CLI command reference](index.md)