hledger Helper (hhelper) - A Command-Line Tool for Managing hledger Files

Github

Welcome to hledger Helper (hhelper), a command-line tool for simplifying and enhancing your experience with hledger, the plain-text accounting tool. Whether you're managing transactions, cleaning up your journal, fetching commodity prices, or generating recurring transactions, hhelper is here to make your life easier.

🌟 Features

hledger Helper comes packed with powerful features to streamline your accounting workflow:

1. Mark Transactions as Cleared Easily mark transactions as cleared directly from the command line. No more manual editing of your ledger files!

2. Clean Up Journal Automatically clean and format your hledger journal file. This includes aligning amounts, removing unnecessary spaces, and ensuring your journal is valid.

3. Fetch Prices Fetch historical commodity prices using Yahoo Finance and append them to your price file. Perfect for keeping your commodity valuations up to date.

4. Generate Recurring Transactions Automatically generate recurring transactions based on your predefined rules. Save time by automating repetitive entries.

🚀 Getting Started

Prerequisites

• Python 3.9 or higher
• hledger 1.25 or higher
• A valid config.toml file in ~/.config/hhelper/ (see example config)

Installation

# install uv (package manager):
curl -LsSf https://astral.sh/uv/install.sh | sh

# restart your terminal, or run the following command:
source $HOME/.local/bin/env # or follow instructions

# install hhelper through uv
uv tool install hhelper

# Run the tool
hh

Screenshots

🛠️ Usage

Once you've launched hhelper, you'll be greeted with a user-friendly menu where you can select from the available options:

1. Mark Transactions as Cleared Navigate through your uncleared transactions and mark them as cleared with a single keypress.

2. Clean Up Journal Automatically clean and format your journal file. The tool will ensure your journal is valid before making any changes.

3. Fetch Prices Fetch historical prices for your commodities and append them to your price file. You can review the fetched prices before saving.

4. Generate Recurring Transactions Generate recurring transactions based on a period expression. Preview the transactions before appending them to your journal.

⚙️ Configuration

hhelper requires a config.toml file located at ~/.config/hhelper/config.toml. This file should define the paths to your ledger, price, header, and recurring transaction files. Here's an example configuration:

[paths]
directory = "~/finance"
ledger_file = "journal.ledger"
price_file = "prices.ledger"
header_file = "header.ledger"
recurring_tx_file = "recurring.ledger"

[commodities]
commodity_pairs = [
    { symbol = "AAPL", base_currency = "USD", quote_currency = "AAPL", is_append_space = true },
    { symbol = "BTC-USD", base_currency = "USD", quote_currency = "BTC", is_append_space = false },
]

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

🙌 Contributing

Contributions are welcomed! If you have ideas for new features, improvements, or bug fixes, please open an issue or submit a pull request. Let's make hhelper even better together!

💬 Feedback

If you have any questions, suggestions, or just want to say hello, feel free to open an issue or reach out to us. We'd love to hear from you!

Happy accounting with hledger Helper! 🎉