retiretui-0.1.0 is not a library.

RetireTui

A local-first retirement planner for the terminal.

You describe a household in one plain TOML file - people, accounts and what they hold, contributions, income, expenses, and the milestones that start and stop them - and RetireTui projects it year by year under U.S. federal and state income tax. The same plan runs through many random or historical markets to show how surely the money lasts, and searches for a better Roth conversion ladder or Social Security claim ages. A scenario is a small file stating only what differs from a base plan, so alternatives compare side by side.

Everything runs locally; no plan leaves your machine. RetireTui is a model under the assumptions you give it, not financial advice.

The interactive planner opening an example plan: the overview, the year-by-year ledger, a Monte Carlo run, and an account opened for editing

Requirements

Rust 1.95 or newer, to build.
A terminal. Truecolor and the kitty keyboard protocol are used where the terminal offers them.

Install

cargo install retiretui

Or download a prebuilt binary for x86_64 or aarch64 Linux from the releases page:

curl -LO https://github.com/kenianbei/retiretui/releases/latest/download/retiretui-x86_64-unknown-linux-gnu.tar.gz
tar xzf retiretui-x86_64-unknown-linux-gnu.tar.gz

Usage

Interactive planner

retiretui tui examples/

Opens a plan, a scenario, or a directory to pick one from. With no plan, a short form builds a first one from the household's basics. The example plans are invented households, from a first job to a retired couple, to try it on.

Command line

command	what it does
`validate`	Check a plan for schema and consistency errors
`project`	Print the year-by-year ledger, as a table or JSON
`actions`	List one year's to-dos: conversions, RMDs, and more
`compare`	Compare plans or scenarios side by side
`optimize`	Search Roth conversions or Social Security claims
`monte-carlo`	Run the plan through many random markets
`historical`	Run the plan from every historical start year
`import-earnings`	Record an ssa.gov earnings statement on a person
`tui`	Open the interactive planner
`mcp`	Serve plans to AI agents over stdio

retiretui <command> --help lists each command's options.

retiretui project examples/starter.toml
retiretui compare examples/early-retiree.toml examples/early-retiree-no-ladder.toml
retiretui monte-carlo examples/market-mix.toml

AI agents

retiretui mcp serves the same tools over the Model Context Protocol, sandboxed to one directory of plans, with a schema reference for writing them. Register it with an MCP client:

{
  "mcpServers": {
    "retiretui": {
      "command": "retiretui",
      "args": ["mcp", "--dir", "/path/to/plans"]
    }
  }
}

Status

Pre-1.0: the plan schema and the commands still change between minor versions, and CHANGELOG.md records what did. Tax law is embedded for 2026; later years are extended by inflation, and --tax-dir adds parameter files for others. ARCHITECTURE.md describes how the system fits together.

Contributing

Changes arrive as pull requests. The checks CI runs are in ci.yml; run them locally before opening one.

License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE)
MIT license (LICENSE-MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

retiretui 0.1.0