/terminal-wallet

Manage your wallet, from the terminal

Primary LanguageJavaScriptMIT LicenseMIT

terminal-wallet

Manage your wallet, from the terminal

Build Status

js-semistandard-style

Why?

Not a long time ago, I used a Google Sheet to manage my wallet, and as a matter of fact, it got tedious soon. Opening the browser, waiting for the page to load, and not being able to update stuff when there's no connectivity, all of that has led me to write this small CLI application, that can be used by anyone to manage their wallet right from the terminal.

CLI

$ npm install --global terminal-wallet
$ wallet --help

  Usage
    wallet debit <value> <purchase details> [-c <category>]
    wallet credit <value> <source details> [-c <category>]
    wallet export
    wallet clear

  Example
    wallet debit 10 'Breakfast, Coffee at Canteen' -c 'Food'

    ✔ Expense written to file!

    wallet credit 2000 'Salary for July 2015' -c 'Salary'

    ✔ Expense written to file!

    wallet stash 1000
    # remove 1000 from the wallet and stash it away
    # (safely) for later use

    wallet unstash 500
    # withdraw 500 from the stash and put it into the
    # wallet for immediate use.

    wallet export

    ✔ Your file can be found at
    /home/siddharth/.local/share/wallet/exported/export-2015-07-06.csv

    wallet clear

    ✔ Account closed. Expense details have been exported to :-
    /home/siddharth/.local/share/wallet/closed/closed-2015-07-06.csv
    Prepared a clean slate, for the next accounting period.

  Options
    -c Category ; Default: '' ; Optional

CLI

wallet debit <value> <purchase details> [-c <category>]

Made a purchase of <value> for <purchase details> under the category <category>
Add a debit entry to your account book.

wallet credit <value> <source details> [-c <category>]

<value> credited to the wallet from <source details> under the category <category>
Add a credit entry to your account book.

wallet export

Export the current state of your account book to a timestamped file.
(Path to the file will be printed when the command completes execution)

wallet clear

Close the account for the last period, and start with a clean slate.
The expenses will be exported to a timestamped file, and can be retrieved. (Typically, This operation can be used at the end of each month, or any period that is convenient for the user.)

wallet stash <value>

Remove money from wallet and stash it for later use.

wallet unstash <value>

Withdraw money from your stash, and credit it to the wallet.

License

MIT © Siddharth Kannan