Skip to main content

Installation

Quick Install (macOS / Linux)

curl -fsSL https://get.entropyfa.com | sh

The default installer is user-local. It installs entropyfa into ~/.entropyfa/bin, updates your shell profile if needed, and does not require sudo.

System-wide Install (Optional)

curl -fsSL https://get.entropyfa.com | sh -s -- --system

Cargo

cargo install --git https://github.com/Entropy-Financial-Technologies/entropyfa-cli.git entropyfa

From Source

git clone https://github.com/Entropy-Financial-Technologies/entropyfa-cli.git
cd entropyfa-cli
cargo build --release
mkdir -p ~/.entropyfa/bin
install -m 755 target/release/entropyfa ~/.entropyfa/bin/entropyfa

Upgrade

entropyfa upgrade

Checks GitHub for the latest release, downloads the new binary, and replaces the current executable when that path is writable. If your existing install is in a system directory, upgrade falls back to ~/.entropyfa/bin instead of prompting for sudo. The CLI also checks for updates in the background.

Quick Start

30-Second Demo

1. Discover what data is available:

entropyfa data coverage

2. Look up 2026 federal income tax brackets for single filers:

entropyfa data lookup --category tax --key federal_income_tax_brackets --year 2026 --filing-status single
{
  "data": {
    "category": "tax",
    "key": "federal_income_tax_brackets",
    "year": 2026,
    "verification_status": "authoritative",
    "pipeline_reviewed": true,
    "source_origin": "reviewed_artifact",
    "sources": [
      {
        "authority": "Internal Revenue Service",
        "url": "https://www.irs.gov/pub/irs-drop/rp-25-32.pdf"
      }
    ],
    "value": [
      { "rate": 0.10, "min": 0, "max": 12400 },
      { "rate": 0.12, "min": 12400, "max": 50400 }
    ]
  },
  "ok": true
}

3. Compute federal tax on $150k wages:

entropyfa compute federal-tax --json '{"filing_status":"single","income":{"wages":150000}}'
{"data":{"total_tax":36209,"effective_rate":0.1649,"marginal_ordinary_rate":0.24,...},"ok":true}

4. Get the schema for any compute command:

entropyfa compute roth-conversion --schema

5. Run a Roth conversion analysis:

entropyfa compute roth-conversion --json '{"filing_status":"married_filing_jointly","income":{"wages":200000},"traditional_ira_balance":500000,"conversion_amount":50000}'

6. Run a Monte Carlo retirement projection with the optional terminal dashboard:

entropyfa compute projection --visual --json '{"starting_balance":1000000,"time_horizon_months":360,"return_assumption":{"annual_mean":0.07,"annual_std_dev":0.15},"cash_flows":[{"amount":-4000,"frequency":"monthly"}]}'

Commands Reference

data coverage

Discover all available reference data embedded in the binary. Returns categories, keys, available years, required parameters, and related topics.

Usage

entropyfa data coverage

Example Output

{
  "data": {
    "count": 17,
    "entries": [
      { "category": "tax", "key": "federal_income_tax_brackets", "years": [2026], "parameters": ["filing_status"] },
      { "category": "tax", "key": "federal_standard_deductions", "years": [2026], "parameters": ["filing_status"] },
      ...
    ]
  },
  "ok": true
}

data lookup

Look up specific reference data by category, key, year, and applicable parameters. Lookup responses now include the value plus verification metadata and source URLs by default.

Usage

entropyfa data lookup [OPTIONS]

Flags

FlagDescriptionRequired
--categoryData category (tax, retirement, etc.)Yes
--keyData key within categoryYes
--filing-statusFiling status filterWhen applicable
--yearReference year (defaults to latest)No
--lived-with-spouse-during-yearRequired for IRMAA lookups when filing status is married_filing_separatelyWhen applicable

Example

entropyfa data lookup --category tax --key federal_income_tax_brackets --year 2026 --filing-status single
{
  "data": {
    "category": "tax",
    "key": "federal_income_tax_brackets",
    "year": 2026,
    "verification_status": "authoritative",
    "completeness": "full",
    "pipeline_reviewed": true,
    "source_origin": "reviewed_artifact",
    "sources": [
      {
        "authority": "Internal Revenue Service",
        "source_class": "primary",
        "url": "https://www.irs.gov/pub/irs-drop/rp-25-32.pdf"
      }
    ],
    "value": [
      { "rate": 0.10, "min": 0, "max": 12400 },
      { "rate": 0.12, "min": 12400, "max": 50400 }
    ]
  },
  "ok": true
}

Lookup Response Fields

FieldDescription
verification_statusCurrent trust status for the entry: authoritative, corroborated, derived, or placeholder
completenessWhether the embedded dataset is full or partial
pipeline_reviewedTrue when the entry has been promoted through the maintainer verification pipeline
source_originWhere provenance came from: reviewed artifact or registry metadata
sourcesSource documents used for the entry. Pipeline-reviewed entries include URLs by default.
valueThe actual reference payload for the requested category/key/params

IRMAA Example

entropyfa data lookup --category insurance --key irmaa_brackets --year 2026 --filing-status married_filing_separately --lived-with-spouse-during-year true

The IRMAA contract distinguishes married-filing-separately taxpayers who lived with a spouse during the year from those who lived apart, because the official CMS and SSA rules use different bracket tables.

Use the global --result-hook-url flag to POST the same JSON envelope to a webhook endpoint.

compute federal-tax

Compute federal income + payroll taxes for a given filing status and income breakdown.

Usage

entropyfa compute federal-tax --json '<JSON>'

When to Use

When a user asks about their federal tax liability, effective tax rate, marginal rate, bracket mechanics, or payroll tax (FICA / SE) consequences.

Schema (What to Gather)

FieldDescriptionRequired
filing_statussingle, married_filing_jointly, married_filing_separately, head_of_household, qualifying_surviving_spouseYes
income.wagesW-2 wagesAt least one income field
income.qualified_dividendsQualified dividend incomeNo
income.long_term_capital_gainsLong-term capital gainsNo
income.short_term_capital_gainsShort-term capital gainsNo
income.taxable_ira_distributionsTaxable traditional IRA distributionsNo
income.taxable_pensionsTaxable pension incomeNo
income.taxable_social_securityTaxable Social Security benefitsNo
income.self_employment_incomeSelf-employment incomeNo
adjustmentsHSA, IRA, student loan interest, other above-the-line adjustmentsNo
deductions.methodstandard or itemized (defaults to standard)No
deductions.itemized_amountAggregate itemized deductions when you already have the final Schedule A totalNo
deductions.state_local_income_or_sales_taxElected state/local income tax or sales tax amount for Schedule A SALTNo
deductions.real_property_taxState and local real property taxesNo
deductions.personal_property_taxDeductible personal property taxesNo
deductions.other_itemized_deductionsNon-SALT itemized deductions to add after the SALT cap is appliedNo
deductions.spouse_itemizesWhether an MFS spouse itemizes, which can force itemized treatmentNo

Use either deductions.itemized_amount or the detailed itemized fields, not both. deductions.state_local_income_or_sales_tax is the elected Schedule A income-or-sales-tax amount, not an automatic sales-tax-table calculation.

Example

entropyfa compute federal-tax --json '{"filing_status":"single","income":{"wages":150000}}'
{
  "data": {
    "gross_income": 150000,
    "agi": 150000,
    "taxable_income": 133900,
    "ordinary_income_tax": 24734,
    "payroll_tax": { "total": 11475 },
    "total_tax": 36209,
    "effective_rate": 0.1649,
    "marginal_ordinary_rate": 0.24
  },
  "ok": true
}

Related: estate-tax, roth-conversion, pension-comparison

compute estate-tax

Compute federal estate tax (Form 706) given a gross estate value.

Usage

entropyfa compute estate-tax --json '<JSON>'

When to Use

When a user asks about estate tax liability, exemption usage, or estate planning. Includes portability (DSUE) analysis.

Schema

FieldDescriptionRequired
gross_estateTotal gross estate valueYes
deductions.maritalMarital deductionNo
deductions.charitableCharitable deductionNo
deductions.debtsDebts and expensesNo
adjusted_taxable_giftsLifetime taxable giftsNo
gift_tax_paidGift tax previously paidNo
deceased_spouse_unused_exclusionDSUE amount (portability)No

Example

entropyfa compute estate-tax --json '{"gross_estate":20000000,"deductions":{"marital":5000000}}'
{
  "data": {
    "gross_estate": 20000000,
    "taxable_estate": 15000000,
    "exemption_amount": 15000000,
    "net_estate_tax": 0,
    "effective_rate": 0,
    "marginal_rate": 0.4
  },
  "ok": true
}

Related: federal-tax

compute rmd

Calculate the Required Minimum Distribution for a single year. Handles owner-lifetime, inherited IRA, spouse beneficiary, and SECURE Act scenarios.

Usage

entropyfa compute rmd --json '<JSON>'

Schema

FieldDescriptionRequired
calculation_yearYear to calculate RMD forYes
prior_year_end_balanceAccount balance at end of prior yearYes
account_typetraditional_ira, 401k, inherited_ira, etc.Yes
owner_birth_dateAccount owner's birth dateYes
spouse_birth_dateSpouse's birth dateNo
spouse_is_sole_beneficiaryWhether spouse is sole beneficiaryNo

Related: rmd-schedule, roth-conversion

compute rmd-schedule

Project multi-year RMD schedule with balance depletion over time.

Usage

entropyfa compute rmd-schedule --json '<JSON>'

Related: rmd, roth-conversion-strategy

compute roth-conversion

Analyze the tax impact of a single-year Roth conversion.

Usage

entropyfa compute roth-conversion --json '<JSON>'

Related: roth-conversion-strategy, federal-tax, rmd

compute roth-conversion-strategy

Multi-year Roth conversion strategy with projected balances and RMD comparison.

Usage

entropyfa compute roth-conversion-strategy --json '<JSON>'

Related: roth-conversion, rmd, rmd-schedule

compute pension-comparison

Compare pension lump sum vs annuity options with tax impact, present value, and Monte Carlo analysis.

Usage

entropyfa compute pension-comparison --json '<JSON>'

Related: federal-tax, projection

compute projection

Run Monte Carlo or linear projection of portfolio balance over time. The CLI always returns the JSON envelope on stdout. The terminal dashboard is opt-in with --visual and renders to stderr in a real terminal.

Usage

entropyfa compute projection --json '<JSON>'
entropyfa compute projection --visual --json '<JSON>'

Delivery: the CLI always writes the JSON envelope to stdout and, if --visual is set, renders the dashboard separately on stderr. If --result-hook-url is set, the same JSON envelope is also POSTed as application/json.

Related: goal-solver, pension-comparison

compute goal-solver

Binary search solver to find the value of a variable that achieves a target metric.

Usage

entropyfa compute goal-solver --json '<JSON>'

Related: projection

Embedded Data and Provenance

Reference data is compiled into the binary and returned with provenance. Use entropyfa data coverage to discover the surface area and entropyfa data lookup to retrieve both the value and its verification metadata.

Trust Model

authoritative means the entry is backed by primary official sources or reviewed maintainer metadata. corroborated means multiple approved secondary sources agree. derived and placeholder remain visible so consumers can make their own trust decision.

Pipeline Reviewed vs Metadata Backed

pipeline_reviewed: true means the entry has gone through a primary agent, verifier agent, human review, and reviewed-artifact apply step. In the current public release, all 30 shipped entries are in this state.

CategoryKeyDescriptionParametersYears
taxfederal_income_tax_bracketsFederal income tax brackets by filing statusfiling_status2026
taxfederal_standard_deductionsFederal standard deduction amounts by filing statusfiling_status2026
taxfederal_salt_deduction_parametersFederal SALT deduction cap, phaseout, and floor by filing statusfiling_status2026
taxfederal_capital_gains_bracketsFederal long-term capital gains tax bracketsfiling_status2026
taxfederal_net_investment_income_taxNet investment income tax rate and thresholdsfiling_status2026
taxfederal_payroll_tax_parametersSocial Security, Medicare, and self-employment tax parametersfiling_status2026
taxfederal_capital_loss_limitAnnual capital loss deduction limitfiling_status2026
taxfederal_qbi_deductionQualified Business Income (Section 199A) deduction parametersfiling_status2026
taxfederal_estate_exemptionFederal estate tax exemption amount2026
taxfederal_estate_bracketsFederal estate tax brackets2026
taxfederal_estate_applicable_creditApplicable credit amount against estate tax2026
retirementuniform_lifetime_tableIRS Uniform Lifetime Table (Table III) for RMDs2026
retirementsingle_life_tableIRS Single Life Expectancy Table (Table I)2026
retirementjoint_life_tableIRS Joint Life and Last Survivor Table (Table II)2026
retirementdistribution_rulesRMD distribution rules (SECURE Act / SECURE 2.0)2026
social_securitybenefit_taxation_thresholdsSS benefit taxation thresholdsfiling_status2026
insuranceirmaa_bracketsMedicare IRMAA surcharge bracketsfiling_status, lived_with_spouse_during_year (MFS only)2026
pensionmortality_417eSection 417(e) mortality table for pension lump sums2026

Representative Lookup Examples

This section shows three common lookup shapes: a bracket table, a compound parameter object, and a scalar estate value.

Federal Income Tax Brackets

entropyfa data lookup --category tax --key federal_income_tax_brackets --year 2026 --filing-status single
{
  "ok": true,
  "data": {
    "category": "tax",
    "key": "federal_income_tax_brackets",
    "year": 2026,
    "verification_status": "authoritative",
    "pipeline_reviewed": true,
    "source_origin": "reviewed_artifact",
    "sources": [
      {
        "authority": "Internal Revenue Service",
        "title": "Revenue Procedure 2025-32 (26 CFR 601.602)",
        "url": "https://www.irs.gov/pub/irs-drop/rp-25-32.pdf"
      }
    ],
    "value": [
      { "min": 0.0, "max": 12400.0, "rate": 0.1 },
      { "min": 12400.0, "max": 50400.0, "rate": 0.12 },
      { "...": "..." },
      { "min": 640600.0, "max": null, "rate": 0.37 }
    ]
  }
}

SALT Deduction Parameters

entropyfa data lookup --category tax --key federal_salt_deduction_parameters --year 2026 --filing-status single
{
  "ok": true,
  "data": {
    "category": "tax",
    "key": "federal_salt_deduction_parameters",
    "year": 2026,
    "verification_status": "authoritative",
    "pipeline_reviewed": true,
    "source_origin": "reviewed_artifact",
    "sources": [
      {
        "authority": "Internal Revenue Service",
        "counts_toward_status": true,
        "locator": "Corrected 2026 state and local income tax deduction amounts by filing status",
        "published_at": "2026-03-16",
        "source_class": "primary",
        "title": "Correction to State and Local Income Tax Deduction Amount in the 2026 Form 1040-ES",
        "url": "https://www.irs.gov/forms-pubs/correction-to-state-and-local-income-tax-deduction-amount-in-the-2026-form-1040-es"
      },
      {
        "authority": "Internal Revenue Service",
        "counts_toward_status": true,
        "locator": "Line 5e worksheet: 30% reduction above modified AGI threshold, but not below the statutory floor",
        "published_at": "2025-12",
        "source_class": "primary",
        "title": "2025 Instructions for Schedule A (Form 1040)",
        "url": "https://www.irs.gov/instructions/i1040sca"
      }
    ],
    "value": {
      "cap_amount": 40400.0,
      "filing_status": "single",
      "floor_amount": 10000.0,
      "phaseout_rate": 0.3,
      "phaseout_threshold": 505000.0
    }
  }
}

Federal Estate Exemption

entropyfa data lookup --category tax --key federal_estate_exemption --year 2026
{
  "ok": true,
  "data": {
    "category": "tax",
    "key": "federal_estate_exemption",
    "year": 2026,
    "verification_status": "authoritative",
    "pipeline_reviewed": true,
    "source_origin": "reviewed_artifact",
    "sources": [
      {
        "authority": "Internal Revenue Service",
        "title": "IRS releases tax inflation adjustments for tax year 2026, including amendments from the One, Big, Beautiful Bill",
        "url": "https://www.irs.gov/newsroom/irs-releases-tax-inflation-adjustments-for-tax-year-2026-including-amendments-from-the-one-big-beautiful-bill"
      }
    ],
    "value": {
      "exemption": 15000000.0
    }
  }
}

This table shows the embedded surface area. For live verification status, completeness, and source URLs, use entropyfa data lookup against the specific entry you care about.

Agent Integration

entropyfa is designed as a tool for AI agents doing financial planning. Here's how to integrate it, including the official OpenClaw skill.

The --schema Workflow

  1. Agent calls entropyfa compute <command> --schema to learn what inputs are needed
  2. Agent gathers required information from the user
  3. Agent constructs JSON input and calls the command
  4. Agent parses JSON output and reasons about results

Design Principles for Agents

--schema

on every command — agents read the schema to know what inputs to gather

data coverage

agents discover what reference data is available without hardcoding keys

JSON-in/JSON-out

structured I/O that agents parse natively

Deterministic

same input always produces the same output

No configuration

install and go, no API keys, no config files, and no outbound calls unless you explicitly use upgrade or result hooks

OpenClaw Quick Start

Install the local entropyfa CLI first, then install the official OpenClaw skill into your current workspace:

clawhub install entropyfa

The official skill is published as entropyFA Financial Planning. It provides verified financial planning data and blazing-fast, deterministic calculators for Monte Carlo projection, goal solving, Roth conversions, RMDs, income tax, estate tax, and pension analysis. Its recommended flow is:

  1. Run entropyfa data coverage to discover available planning datasets.
  2. Run entropyfa data lookup ... when the user needs official yearly values, trust status, or source URLs.
  3. Run entropyfa compute <command> --schema when required inputs are missing.
  4. Run entropyfa compute <command> --json '<JSON>' once the inputs are known.
  5. Use compute projection --visual only when a human actually wants the terminal dashboard.

Trust note: install from the official entropyfa slug only, and review the source at github.com/Entropy-Financial-Technologies/entropyfa-cli/tree/main/integrations/openclaw/entropyfa.

Architecture

Runtime Data Flow

--json '<JSON>' / flags  →  entropyfa CLI  →  entropyfa-engine  →  stdout (JSON envelope)
                                                   \
                                                    →  optional webhook POST

Verification Pipeline

primary agent  →  verifier agent  →  human review  →  reviewed artifact
                                                           \
                                                            →  generated Rust data + metadata + snapshot

Key Properties

Local by default

Reference data and provenance are compiled into the binary; outbound calls are opt-in

Sub-millisecond

Pure computation, no I/O overhead

Single binary

No runtime dependencies

Versioned releases

Updated as reviewed reference data changes are promoted into the binary

Workspace Structure

CratePurpose
engineEmbedded reference data, provenance artifacts, and computation logic (usable as a Rust library)
cliCLI that accepts JSON via --json flag, writes JSON envelopes to stdout, and can optionally POST result envelopes

Releases

entropyFA ships versioned releases as reviewed data updates are promoted into the binary. Each release bundles the current embedded dataset and provenance state at that version.

Upgrade: entropyfa upgrade