GithubHelp home page GithubHelp logo

quick-inventory's Introduction

Quick Inventory

This CLI tool lets you enter and search for any generic inventory with an extreme bias toward data entry speed. Super handy for tracking lots of your junk.

Installing

After cloning this repository and having Node.js version 10 or greater installed, cd into the root of this repository and run:

npm install

CLI

The CLI supports 2 commands: add and search.

Searching Inventory

Search your inventory based on keyword matching or location. You can then select matching hits to get the current locations and quantities.

Running Search

Run search.(sh/bat) depending on your OS and follow prompts. Search for exit to quit the program.

Add Inventory

Adding inventory is intended for speed over extreme precision, so only a (long, keyword-based) name, location and quantity is recorded for each item. When naming the item, think about what keywords you'd search for when finding it later.

Running Add

Run add.(sh/bat) depending on your OS and follow prompts. Typing exit for an item name will quit the program.

Pro Tips

Tip 1: Use Nested Locations

Every item must be in a location, but your location can also be an item. For example, let's say you have a hammer located in bin B1, so you add the hammer item as such. If you then add B1 as an item itself, you can specify it's location in the Attic. Adopting your own nested location scheme will allow you to find anything globally in a consistent way. Future versions of this tool will figure out the entire location hierarchy so this nesting pattern is highly encouraged.

Tip 2: Add similar items in batches to go faster with autocomplete

If certain patterns reoccur across multiple item entries (such as locations B1, then B2), you may get pre-filled name and location suggestions (such as B3). Press nothing but enter when appropriate to accept suggestions and zoom through data entry.

Tip 3: Backup your inventory record

All of your inventory is stored in the inventory.json file next to this Readme. Backup this file on occassion to ensure you don't lose valuable time.

Removing Inventory

While strict deletion isn't supported, you can always add an existing item by exact name and set it's quantity to zero.

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.