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

51 lines
1.8 KiB
Markdown

# `zfin analysis`
Break your portfolio down by asset class, sector, geography, account,
and tax type.
```
Usage: zfin analysis [FILE]
```
Renders a bar breakdown along five axes, plus an umbrella-exposure
estimate. The Asset Category / Sector / Geographic axes use
[`metadata.srf`](../config/metadata-srf.md); the Tax Type axis uses
[`accounts.srf`](../config/accounts-srf.md). Unclassified holdings and
unmapped accounts are shown as such.
## Example
```bash
ZFIN_HOME=examples/pre-retirement-both zfin analysis
```
```
Asset Category
Equity ██████████████████████████▋ 89.2% $1,233,151.30
Fixed Income ██ 7.0% $96,922.00
Cash █▏ 3.8% $53,064.51
By Tax Type
Traditional (Pre-Tax) █████████████████▋ 58.9% $815,290.06
Taxable ██████▍ 21.6% $299,010.60
Roth (Post-Tax) █████ 16.9% $233,732.95
HSA (Triple Tax-Free) ▊ 2.5% $35,104.20
Umbrella exposure
Total liquid: $1,383,137.81
Shielded (retirement accounts): $1,084,127.21
Exposed (taxable + non-shielded pre-tax): $299,010.60 (21.6%)
```
The umbrella block's shielded/exposed split can be overridden per
account with `shielded:bool:false` in `accounts.srf`.
## See also
- [Read your portfolio](../../guides/read-your-portfolio.md#analysis-allocation-breakdowns)
- [Classify your holdings](../../guides/classify-holdings.md) / [Map your accounts](../../guides/set-up-accounts.md)
- [`review`](review.md) / [`exposure`](exposure.md)
---
[CLI command reference](index.md)