{"id":16515074,"url":"https://github.com/ebullient/pockets-cli","last_synced_at":"2025-10-28T04:32:48.192Z","repository":{"id":37879345,"uuid":"436047874","full_name":"ebullient/pockets-cli","owner":"ebullient","description":"D\u0026D Inventory tracking CLI","archived":true,"fork":false,"pushed_at":"2024-12-19T04:11:42.000Z","size":944,"stargazers_count":3,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-09T01:15:13.732Z","etag":null,"topics":["cli","dungeons-and-dragons","inventory","loot","quarkus"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ebullient.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"custom":"https://www.buymeacoffee.com/ebullient"}},"created_at":"2021-12-07T22:49:36.000Z","updated_at":"2024-12-19T04:13:13.000Z","dependencies_parsed_at":"2023-02-19T09:16:02.147Z","dependency_job_id":"31b2266f-292f-4469-b180-35acc2ef8ec8","html_url":"https://github.com/ebullient/pockets-cli","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebullient%2Fpockets-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebullient%2Fpockets-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebullient%2Fpockets-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebullient%2Fpockets-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ebullient","download_url":"https://codeload.github.com/ebullient/pockets-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238597388,"owners_count":19498396,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","dungeons-and-dragons","inventory","loot","quarkus"],"created_at":"2024-10-11T16:15:03.625Z","updated_at":"2025-10-28T04:32:42.857Z","avatar_url":"https://github.com/ebullient.png","language":"Java","funding_links":["https://www.buymeacoffee.com/ebullient"],"categories":[],"sub_categories":[],"readme":"# Pockets ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ebullient/pockets-cli/maven.yml?branch=main) [![](https://jitpack.io/v/ebullient/pockets-cli.svg)](https://jitpack.io/#ebullient/pockets-cli) \n\nA TTRPG Inventory tracking CLI\n\n\u003ctable\u003e\u003ctr\u003e\u003ctd\u003eJump: \u003c/td\u003e\n\u003ctd\u003e\u003ca href=\"#install-it\"\u003eInstall It\u003c/a\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ca href=\"#use-it\"\u003eUse it\u003c/a\u003e\u003c/td\u003e\n\u003ctd\u003e\u003ca href=\"#build-it-optional\"\u003eBuild it (Optional)\u003c/a\u003e\u003c/td\u003e\u003c/tr\u003e\u003c/table\u003e\n\nThis project is built using [Quarkus](https://quarkus.io), the Supersonic Subatomic Java Framework, and is packaged and distributed as non-invasively as possible with help from [JBang!](https://jbang.io). It uses Picocli, JPA, Hibernate, and H2.\n\nGoals: \n- [x] Track the contents of multiple \"pockets\"\n- [x] Add/remove items from a pocket\n- [ ] Keep a record of additions, removals and exchanges (a ledger)\n- [ ] Track cumulative value of items in a pocket (and then across pockets)\n- [ ] Allow addition of standard items (with quick modifications as necessary)\n\n## Install the command line utility\n\n- [Use pre-built platform binary](#use-pre-built-platform-binary)\n- [Use Java Jar](#use-java-jar)\n- [Build from source](#build-and-run)\n\n### Use pre-built platform binary\n\n[Download the latest release](https://github.com/ebullient/pockets-cli/releases/latest) of the zip or tgz for your platform. Extract the archive. A `pockets` binary executable will be in the extracted bin directory. \n\n```shell\npockets --help\n```\n\nUse this binary in the instructions below. Continue to notes about [Conventions](#conventions).\n\nNotes:\n\n- [Open a command prompt in a folder (Windows) ](https://www.lifewire.com/open-command-prompt-in-a-folder-5185505)\n- [Running executables from the command line (Windows)](https://www.techwalla.com/articles/how-to-use-quotcdquot-command-in-command-prompt-window)\n\n### Use Java Jar\n\n1. Install JBang: https://www.jbang.dev/documentation/guide/latest/installation.html\n\n2. Install the pre-built release: \n\n    ```shell\n    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\n    ```\n\n    If you want the latest unreleased snapshot: \n\n    ```shell\n    jbang app install --name pockets --force --fresh https://jitpack.io/dev/ebullient/pockets-cli/199-SNAPSHOT/pockets-cli-199-SNAPSHOT-runner.jar\n    ```\n\n    There may be a pause if you download the snapshot; it is rebuilt on demand.\n\n    \u003e 🔹 Feel free to use an alternate alias by replacing the value specified as the name: `--name pockets`, and adjust the commands shown below accordingly.\n\n3. Verify the install by running the command: \n\n    ```shell\n    pockets --help\n    ```\n\n### Build and run\n\n1. Clone this repository\n2. Build this project: `quarkus build` or `./mvnw install`\n3. Verify the build: `java -jar target/pockets-cli-199-SNAPSHOT-runner.jar --help`\n\nTo run commands listed below, either: \n\n- Replace `5e-convert` with `java -jar target/pockets-cli-199-SNAPSHOT-runner.jar`, or\n- Use JBang to create an alias that points to the built jar: \n\n    ```shell\n    jbang app install --name pockets --force --fresh ~/.m2/repository/dev/ebullient/pockets-cli/199-SNAPSHOT/pockets-cli-199-SNAPSHOT-runner.jar\n    ```\n\n    \u003e 🔹 Feel free to use an alternate alias by replacing the value specified as the name: `--name pockets`, and adjust the commands shown below accordingly.\n\n## Use it\n\n```\n$ pockets --help\n\nWhat have you got in your pockets?\n...\n```\n\nUse `--help` with any of the subcommands for more details about what they do, etc.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febullient%2Fpockets-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Febullient%2Fpockets-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febullient%2Fpockets-cli/lists"}