Inventory

Join the chat at https://gitter.im/skylerto/inventory

Build
Status Code
Climate Coverage
Status Dependency
Status

Manage inventory with this and mysql.

Installation

Add this line to your application's Gemfile:

gem 'inventory-cli'

And then execute:

$ bundle

Or install it yourself as for the cli by:

$ gem install inventory-cli

Add a table to manage:

$ mysql -uroot
CREATE TABLE inventory;

Usage

After installation, to get a list of available commands run

$ inventory
Commands:
  inventory add AMOUNT ITEM     # Add an amount of an item
  inventory help [COMMAND]      # Describe available commands or one specific command
  inventory invoice NAME args*  # Create an invoice
  inventory remove AMOUNT ITEM  # Remove an amount of an item
  inventory show                # Shows the current state of the inventory

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake rspec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/skylerto/inventory.

License

The gem is available as open source under the terms of the MIT License.

To do

  • Add some way to control orders, look at how rails goes about rails generate ... vs rails server for inspiration.
  • Add a script to create a database off the start, maybe like inventory install.