budget/README.md

2.1 KiB

Latest Build:

TeamCity build status

BuildServer:

TeamCity

Output of budget.

Usage:
	budget <action> [options] ...
Actions:
	-h --help                            Prints this.
	-a --account<=STRING>                Management tools for an account.
	-c --create<=STRING>                 Creates a new account with NAME.
	-e --earn<=STRING>                   Add an earning to an account.
	-p --payment<=STRING>                Add a payment to an account.
Account Options: [-dvD]
	-d --delete                          Deletes specified account.
	--force-delete                       Deletes the specified account without confirmation.
	-v --value                           Gets the current value of the account.
	-D --description<=STRING>            Changes the description of the account.
Create Options: [-d]
	-d --description<=STRING>            Sets a description for an account.
Earn Options: -v [-drD]
	-v --value=<FlOAT>                   Value for earning.
	-d --description=<STRING>            Description for earning.
	-r --receipt=<PATH>                  Path to file to store in DB as receipt.
	-D --date=<mm/dd/yyyyTHH:MM:SS>      Date as dd/mm/yyyyTHH:MM:SS. Default will be today.
Payment Options: -v [-drD]
	-v --value=<FlOAT>                   Value for payment.
	-d --description=<STRING>            Description for payment.
	-r --receipt=<PATH>                  Path to file to store in DB as receipt.
	-D --date=<mm/dd/yyyyTHH:MM:SS>      Date as dd/mm/yyyyTHH:MM:SS. Default will be today.

Arguments are processed like blocks with each one terminated by the next Action. For example

budget -cAcct -eAcct -v10.00 -r"./receipt.pdf" -pAcct -v5.50 -r"./payment.pdf"

Does the following in order: Creates an accountName named Acct with no description. Earns 10.00 to it with a receipt. Pays 5.50 to it with a receipt.