Quick start

Set environment variable

WIMM needs to know where its database is located. This path id defined in WIMM_PATH environment variable. Most convinient way to set the environment variable is to add a line to .bashrc file: 

export WIMM_PATH=/home/user/accounting

But you can also just set the variable for current working dir like this: WIMM_PATH="$PWD"

You can check the configuration with wimm info:

$ wimm info
Data location: /home/jev/temp
Hashed files: 0

Init database

wimm init files will create the necessary files and folders.

Displaying balance

After initialisation you shold be able to view current balance:

$ wimm show balance
----------Balance-----------
Assets               0.0
Assets.Bank          0.0
Assets.bank       1100.0
Expenses            50.0
Ext.Bob          -1000.0
INR.00_000           0.0
Liabilities       -150.0
tax.to_pay           0.0
tax.to_receive       0.0
----------------------------
SUM: 0.00

Note

WIMM treats invoices as separate accounts. account value of 0 indicates that the corresponding invoice has been payed.

Tip

use --nozeros option to hide accounts with zero values use --depth option to collapse accounts to a desired level

$ wimm show balance --nozeros --depth 1
----------Balance-----------
Assets         1100.00
Expenses         50.00
Ext           -1000.00
INR            -142.40
Liabilities    -150.00
tax              24.71
----------------------------
SUM: -117.69

Attention

The account names on the balance are currently generated from transactions. This means that every account mentioned will appear on the balance. It would be better to show only the accounts defined in balance.yaml. This behavior is planned to be implemented later.

Adding invoices

Invoices can be added with wimm add invoce FILENAME. The invoice should be a pdf file. A dialog will be presented to guide you through the addition process. WIMM will also try to open the pdf file in system viewer.

Note

Multiple invoices can be added with a wildcard pattern *.pdf. Other patterns are also possible.

Note

Files added to the database are tracked by their md5 hashses. The hashes are stored in .wimm/hashes file. The files with hashes present in the database will be skipped. hashes file may be deleted and recreated with wimm init hash hash command