User Guide: General Use - ncdulo/suppylement GitHub Wiki
General Use
Suppylement aims to be simple and intuitive to use. The full set of arguments
has not be decided on or implemented yet but anything that is can be listed
with the -h
or --help
argument. Some basic examples are listed below. Note
that some (most) functionality is currently not fully implemented.
Quickstart
# Display help
suppylement --help
suppylement log --help
# List most recent 5 entries
suppylement list
# List most recent 20 entries
suppylement list --most-recent 20
# Log a new entry
suppylement log 1000 VitaminC
suppylement log 250 magnesium-citrate
# Delete the most recent entry
suppylement rm
# Delete the most recent 5 entries
suppylement rm --most-recent 5
# View statistics
suppylement stats
# View full statistics
suppylement stats --full