Introduction
Welcome to the kakei documentation!
kakei is a command-line application for managing personal finances using the Japanese kakeibo (家計簿) method. It provides transaction tracking, categorization, and powerful Lisp-based table transformations for flexible analysis and reporting.
What is Kakeibo?
Kakeibo (家計簿) is a Japanese household financial ledger system that emphasizes mindful spending and saving. The word combines:
- 家計 (kakei): household finances
- 簿 (bo): ledger/account book
Key Features
- 📊 Transaction Management: Add, list, and manage financial transactions
- 🏷️ Category & Account Organization: Organize transactions by customizable categories and accounts
- 🔄 Lisp-Based Transformations: Transform and analyze transaction data using a small Lisp dialect
- 📋 Table Display: Beautiful table formatting using the
tabledcrate - 💾 SQLite Database: Persistent storage with automatic migrations
- ⚙️ Configuration: Customizable categories and accounts
Why kakei?
Traditional financial tracking tools can be rigid and inflexible. kakei takes a different approach:
- Flexible Data Analysis: Use Lisp expressions to transform and analyze your financial data in any way you need
- Command-Line First: Designed for developers and power users who prefer the command line
- Open and Portable: Your data is stored in a standard SQLite database that you fully control
- Extensible: The Lisp-based transformation system allows for unlimited customization
Getting Started
If you're new to kakei, we recommend:
- Start with the Installation guide to get kakei installed on your system
- Follow the Quick Start guide to initialize your database and add your first transactions
- Explore the Commands reference to learn all available commands
- Learn about Lisp Functions to unlock powerful data transformations
Contributing
kakei is open source and welcomes contributions! See the Contributing guide for more information.
License
kakei is licensed under the MIT License. See the repository's LICENSE file for details.
Author
haruki7049 tontonkirikiri@gmail.com