budget/README.md

42 lines
1.6 KiB
Markdown
Raw Normal View History

2023-01-15 17:50:01 -06:00
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.
2023-01-15 19:37:49 -06:00
Account Options: [-dvD]
2023-01-15 17:50:01 -06:00
-d --delete Deletes specified account.
--force-delete Deletes the specified account without confirmation.
-v --value Gets the current value of the account.
2023-01-15 19:37:49 -06:00
-D --description<=STRING> Changes the description of the account.
2023-01-15 17:50:01 -06:00
Create Options: [-d]
2023-01-15 19:37:49 -06:00
-d --description<=STRING> Sets a description for an account.
2023-01-15 17:50:01 -06:00
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=<dd/mm/yyyy> Date as dd/mm/yyyy. Default will be today.
-t --time=<hh/mm/ss> 24 hour time as hh/mm/ss. Default will be now.
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=<NUM/NUM/NUM> Date as dd/mm/yyyy. Default will be today.
-t --time=<hh/mm/ss> 24 hour time as hh/mm/ss. Default will be now.
```
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:
1. Creates an account named ``Acct`` with no description.
2. Earns ``10.00`` to it with a receipt.
3. Pays ``5.50`` to it with a receipt.