inven

Keep track of all your stuff from the command line. Manage your physical belongings with inven 📦📜

Installation

Build and installation requirements:

• GHC
• Stack

Haskell dependencies: filepath, optparse-applicative, process, time, xdg-basedir, yaml, regex-posix

git clone https://github.com/mo42/inven.git && cd inven
stack install

If you have .local/bin in your PATH environment variable, you should be able to run the inven command.

Usage

$ inven --help
Usage: inven COMMAND

Available options:
  -h,--help                Show this help text

Available commands:
  add                      Add an item
  find                     Find item by reg. exp.
  remove                   Remove an item
  value                    Sum of all values
  count                    Number of items
  edit                     Edit item in editor manually
  consume                  Consume item (ie, decrement quantity)
  prune                    Clear items from database where quantity is zero
  show                     Show item

Add item to your inventory

Examples

inven add --text="Some item description"
inven add --text="Some item description" --value=42.42 --date=2023-07-01

Required and optional parameters or attributes

$ inven add
Missing: --text description

Usage: inven add --text description [--date date] [--quantity quantity]
                 [--value value] [--price price] [--category category]
                 [--container container] [--location location] [--expiry expiry]

Remove or consume item from inventory by ID

Consume means that used up one piece (ie, the quantity is decremented). Remove means that the entire record is deleted.

inven consume 42
inven remove 43

Search Inventory Database

$ inven find --regexp="music"
   ID Category             Description
   01 music                Yamaha CP5
   11 sheet music          Bach The Well-Tempered Clavier

License

This project is licensed under the MIT License - see the LICENSE file for details.