Skip to content

Latest commit

 

History

History
90 lines (62 loc) · 4.47 KB

README.md

File metadata and controls

90 lines (62 loc) · 4.47 KB
Raw

Sage Build Status Coverage Status Sage Downloads Count

Be your own accountant, without the stress.

Examine your finances with ease. Automatically download transactions from your banks and credit cards, then run the numbers.

Get the latest release here, then let us know what you think!

Activity page demo

See your latest balances, expenses, and transactions.

Features

  • Securely & automatically download data directly from your bank or credit card company
  • View and edit transactions, balances, and budgets
  • Uses double-entry bookkeeping to keep things in check
  • Web Connect (beta) and Direct Connect support
  • Can deploy as a single binary or as a Docker container
  • Automatic version control

Budgets page demo

Manage monthly budgets to keep track of your expenses.

Install

Choose one of the following options:

DATA_DIR=$HOME/sage
mkdir "$DATA_DIR"
docker run \
    --detach \
    --name sage \
    --publish 127.0.0.1:8080:8080 \
    --volume "$DATA_DIR":/data \
    johnstarich/sage
# Visit http://localhost:8080 in your browser
  • Download and install the latest Sage server release from the releases page or this script:
curl -fsSL -H 'Accept: application/vnd.github.v3+json' https://api.github.com/repos/JohnStarich/sage/releases/latest | grep browser_download_url | cut -d '"' -f 4 | grep -i "$(uname -s)-$(uname -m)" | xargs curl -fSL -o sage
chmod +x sage
./sage -help  # Optionally move sage into your PATH
  • OR download the source and build it: go get github.com/johnstarich/sage

Usage

For available options, run sage -help

Future work

  • Over-budget notifications
  • Forecasts on current transactions to identify trends
  • Smarter categorization by training on current ledger

Data storage

Sage uses a ledger (plain text accounting) file, some simple JSON-encoded files, and an hledger rules file. You won't need to know about these files to use Sage. However, if you're a power-user, then these formats may come in handy.

The ledger will store all of your transactions in plain text so you can easily read it with any text editor. It also supports several other tools that can generate reports based on your ledger.

Warning: Some banks, like Bank of America, may charge a fee for downloading transactions. While this is uncommon, we are not responsible for these charges. Do your homework if you want to be certain these charges won't apply to you.

The rules file is a format designed by the hledger project for importing CSVs. This file will help Sage automatically categorize incoming transactions into the appropriate accounts for your ledger. After a transaction has been imported, it is assigned an account (category) from this file. To follow convention, only include rules to change the account2 field or a comment. While changing account1 is supported, it will likely cause problems with Sage since account1 is assumed to be the source institution of the transaction. Currently, the web UI only supports account2.

Awesome libraries 👏

Sage relies on aclindsa/ofxgo for it's excellent Go implementation of the OFX spec.