Coder Social home page Coder Social logo

ebullient / pockets-cli Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 3.0 861 KB

D&D Inventory tracking CLI

License: Apache License 2.0

Java 82.86% HTML 0.10% Svelte 11.06% SCSS 2.35% TypeScript 3.54% JavaScript 0.10%
cli dungeons-and-dragons inventory loot quarkus

pockets-cli's Introduction

Pockets GitHub Workflow Status

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

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:

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.

pockets-cli's People

Contributors

dependabot[bot] avatar ebullient avatar github-actions[bot] avatar sanne avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

pockets-cli's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.