Pockets

A TTRPG 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 the command line utility

• Use pre-built platform binary
• Use Java Jar
• Build from source

Use pre-built platform binary

Download the latest release of the zip or tgz for your platform. Extract the archive. A pockets binary executable will be in the extracted bin directory.

pockets --help

Use this binary in the instructions below. Continue to notes about Conventions.

Notes:

• Open a command prompt in a folder (Windows)
• Running executables from the command line (Windows)

Use Java Jar

1. Install JBang: https://www.jbang.dev/documentation/guide/latest/installation.html

2. Install the pre-built release:

   jbang app install --name pockets --force --fresh https://github.com/ebullient/pockets-cli/releases/download/1.0.2/pockets-cli-1.0.2-runner.jar

   If you want the latest unreleased snapshot:

   jbang app install --name pockets --force --fresh https://jitpack.io/dev/ebullient/pockets-cli/199-SNAPSHOT/pockets-cli-199-SNAPSHOT-runner.jar

   There may be a pause if you download the snapshot; it is rebuilt on demand.

   🔹 Feel free to use an alternate alias by replacing the value specified as the name: --name pockets, and adjust the commands shown below accordingly.

3. Verify the install by running the command:

   pockets --help

Build and run

1. Clone this repository
2. Build this project: quarkus build or ./mvnw install
3. Verify the build: java -jar target/pockets-cli-199-SNAPSHOT-runner.jar --help

To run commands listed below, either:

• Replace 5e-convert with java -jar target/pockets-cli-199-SNAPSHOT-runner.jar, or

• Use JBang to create an alias that points to the built jar:

  jbang app install --name pockets --force --fresh ~/.m2/repository/dev/ebullient/pockets-cli/199-SNAPSHOT/pockets-cli-199-SNAPSHOT-runner.jar

  🔹 Feel free to use an alternate alias by replacing the value specified as the name: --name pockets, and adjust the commands shown below accordingly.

Use it

$ pockets --help

What have you got in your pockets?
...

Use --help with any of the subcommands for more details about what they do, etc.