Mortgage Calculator

Multi-purpose utility tool for managing structured data entries related to mortgage and financial calculations. Add, list, search, remove, and export data items — all stored locally in a simple log-based format with full history tracking.

Commands

All commands are invoked via mortgage-calculator <command> [args].

Data Storage

• Location: ~/.local/share/mortgage-calculator/ (override with MORTGAGE_CALCULATOR_DIR environment variable, or XDG_DATA_HOME)
• Data log: data.log — stores all entries added via add, one per line, prefixed with YYYY-MM-DD
• History: history.log — every command execution is recorded with a timestamp (MM-DD HH:MM command: details) for auditing
• Format: Plain text, one entry per line, human-readable

Requirements

• Bash 4+
• Standard Unix utilities (date, grep, cat, echo)
• No external dependencies, no API keys, no network access needed

When to Use

1. Financial record keeping — Use mortgage-calculator add to log mortgage-related events (payments made, rate changes, lender communications) and build a local history
2. Payment tracking — Record monthly payments, extra payments, or escrow changes with add, then review the full log with list
3. Comparison notes — Store notes from different loan scenarios or lender quotes using add, then search to find specific terms or rates
4. Data export for spreadsheets — Use mortgage-calculator export to dump all entries to stdout and redirect to a file for import into Excel or Google Sheets
5. Automation and scripting — Integrate mortgage-calculator add and mortgage-calculator export into shell scripts or cron jobs for automated financial logging workflows

Examples

# Initialize the data directory
mortgage-calculator init

# Add a mortgage payment record
mortgage-calculator add "Monthly payment: ¥4,235.00 — principal ¥2,100 + interest ¥2,135"