Git Product home page Git Product logo

pockets-cli's Introduction

Pockets GitHub Workflow Status

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 it

  1. Install JBang: https://www.jbang.dev/documentation/guide/latest/installation.html
  2. 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
  1. Run the command:
pockets --help

Use it

$ 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.

Build it (optional)

Prerequisites: Java 11 and Maven

  1. Clone this repository
  2. Build this project: quarkus build or ./mvnw install
  3. 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

pockets-cli's People

Contributors

ebullient avatar dependabot[bot] avatar sanne avatar

Watchers

 avatar

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.