CLI reference

The aforro binary is shipped by the npm package. Every command accepts --json for machine-readable output; without it, the output is a human-friendly table or key-value layout.

pnpm add -g igcp-aforro
aforro --help

`aforro simulate`

Simulate an IGCP Aforro Série D, E, or F cohort up to an as-of date.

aforro simulate \
  --subscribed 2024-03-15 \
  --units 1000 \
  [--as-of 2026-04-19] \
  [--schedule] \
  [--irs 0.28] \
  [--series F] \
  [--json]

Flag	Description
`--subscribed <date>`	Subscription date (`YYYY-MM-DD`). Required.
`--units <n>`	Principal in EUR; integer in the series’ `[minUnits, maxUnits]` range (Série F: `[100, 100000]`; Séries D/E: `[100, 250000]`). Required.
`--as-of <date>`	As-of date (`YYYY-MM-DD`). Defaults to today (UTC).
`--schedule`	Include the per-quarter capitalization schedule.
`--irs <rate>`	Override IRS withholding rate (e.g. `0.28`). Defaults to series default.
`--series <code>`	Series code. Accepts `D`, `E`, or `F`. Defaults to `F`.
`--json`	Emit JSON instead of the pretty layout.

`aforro current`

Print the IGCP-published monthly base rate for the current (or given) month.

aforro current [--series D|E|F] [--as-of 2026-04-19] [--json]

Includes the fixingDate so you can audit the value back to a single Euribor 3M observation in src/data/euribor3m.json.

`aforro rates`

Print monthly base rates between --from and --to (inclusive).

aforro rates --from 2023-06 --to 2026-04 [--series D|E|F] [--json]

Months are accepted as YYYY-MM. The output is one row per resolvable month — months without a bundled fixing are skipped.

`aforro cohort`

Resolve the annual rate that applies to a cohort for a given quarter.

aforro cohort \
  --subscribed 2024-03 \
  --as-of 2026-04 \
  [--series D|E|F] \
  [--json]

--subscribed and --as-of accept either YYYY-MM or YYYY-MM-DD. Returns the composite annual rate, its base + premium components, and the quarter window they apply to.

`aforro tax-year`

Calendar-year totals of gross interest and IRS withheld at quarterly capitalizations (IRS filing helper; does not map Anexo E box numbers).

aforro tax-year --subscribed 2024-03-15 --units 1000 --year 2025 [--series F] [--as-of 2026-04-19] [--json]
aforro tax-year --input ./portfolio.json --year 2025 [--json]
aforro tax-year --cohort F,2024-03-15,1000 --cohort E,2018-01-15,2500 --year 2025 --as-of 2026-04-19

Flag	Description
`--year <yyyy>`	Calendar year to report. Required.
`--subscribed`, `--units`	Single cohort (same as `simulate`).
`--input`, `--cohort`	Portfolio mode (same as `portfolio`); do not combine with `--subscribed` / `--units`.
`--as-of`, `--irs`, `--series`	Same as `simulate` / `portfolio`.
`--json`	Emit `TaxYearRollup` or `PortfolioTaxYearRollup`.
`--csv`	One-row CSV (single cohort only; not with `--json`).

Totals bucket schedule rows by quarter end date (quarterEndDate). Mid-quarter accrued interest is excluded. See Methodology — calendar-year roll-up.

`aforro fetch-euribor`

aforro fetch-euribor [--mode seed|incremental|range]

Cross-cutting flags

--json — emit machine-readable output. Stable across releases (changes are flagged in the Changelog).
--help and --version — provided by cac.