8 releases (4 breaking)

new 0.5.5 Jun 12, 2024
0.5.4 Jun 12, 2024
0.5.3 May 29, 2024
0.4.0 May 27, 2024
0.1.0 May 23, 2024

#2247 in Command line utilities

Download history 345/week @ 2024-05-19 479/week @ 2024-05-26 22/week @ 2024-06-02

846 downloads per month

MIT license

595KB
441 lines

Budget Tracker crates.io

A minimal TUI based budget tracker.

Track your expenses and income by recording the date, a brief description, the type of transaction, and the amount spent or received. You can create custom expense types when adding transactions. For example, you might use:

  • Food
  • Travel
  • Fun
  • Medical
  • Personal

The data by default is stored at ~/.local/share/budget-tracker/expenses.csv.

Usage

  • To install the program, make sure to have cargo installed, then run the following command.
cargo install budget-tracker

If the PATH is not set directly add the following to your shell profile.

export PATH="$HOME/.cargo/bin:$PATH"
  • To see graphical representation of your budget, run:
budget-tracker
  • To add a new entry (add - infront of amount to show expenses) run any one of the following:
budget-tracker --add
budget-tracker -a
  • To manually edit the database run any one of:
budget-tracker --edit
budget-tracker -e

By default it opens using nano. To specify an editor set the EDITOR environment variable.

EDITOR=vim budget-tracker --edit

This will open the file in vim.

  • To search for a keyword or a particular expense type you can run as follows
budget-tracker -s <SEARCH_QUERY>
budget-tracker --search <SEARCH_QUERY>

Here the search query can either be a substring of the description (the search support fuzzy searching) or the expense type, the program automatically accounts for both.

  • To exit press 'q'

Dependencies

~8–20MB
~213K SLoC