A D&D Inventory tracking CLI
Jump: | Install It | Use it | Build it (Optional) |
This project is built using Quarkus, the Supersonic Subatomic Java Framework, and is packaged and distributed as non-invasively as possible with help from JBang!. It uses Picocli, JPA, Hibernate, and H2.
Goals:
- Track the contents of multiple "pockets"
- Add/remove items from a pocket
- Keep a record of additions, removals and exchanges (a ledger)
- Track cumulative value of items in a pocket (and then across pockets)
- Allow addition of standard items (with quick modifications as necessary)
- Install JBang: https://www.jbang.dev/documentation/guide/latest/installation.html
- Install the snapshot jar:
jbang app install --name pockets --force --fresh https://jitpack.io/dev/ebullient/pockets-cli/1.0.0/pockets-cli-1.0.0-runner.jar
- Run the command:
pockets --help
$ pockets --help
What have you got in your pockets?
pockets [-bdhV] [--config=<config>] [COMMAND]
Options:
-d, --debug Enable debug output
-b, --brief Brief output
--config=<config> Config directory. Default is ~/.pockets
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
Commands:
c, create Create a new pocket
e, edit Edit the attributes of a pocket
o, open Open a pocket (interactive)
d, delete Delete a pocket (and all contained items and history)
l, list List all pockets, or the contents of one pocket
a, add Add an item to a pocket
u, update Update an item in a pocket
r, remove Remove an item from a pocket
import Import reference items and pockets
Use --help
with any of the subcommands for more details about what they do, etc.
Prerequisites: Java 11 and Maven
- Clone this repository
- Build this project:
quarkus build
or./mvnw install
java -jar target/pockets-cli-1.0.0-runner.jar --help
If you want to use the snazzy alias with your freshly built local snapshot, JBang can help with that, too:
jbang app install --name pockets --force ~/.m2/repository/dev/ebullient/pockets-cli/1.0.0/pockets-cli-1.0.0-runner.jar