Cmdlet
Cmdlet provides a set of functions (wrapped in the command pattern) that perform simple actions
Installation
Add this line to your application's Gemfile:
gem 'cmdlet'
And then execute:
bundle install
Or install it yourself as:
gem install cmdlet
Stories
Main Story
As a Developer, I want to use simple categorized functions so that I can easily add commonplace functionality to my application
See all stories
Usage
See all usage examples
Development
Checkout the repo
git clone https://github.com/klueless-io/cmdlet
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests.
You can also run bin/console
for an interactive prompt that will allow you to experiment.
bin/console
Aaa::Bbb::Program.execute()
# => ""
cmdlet
is setup with Guard, run guard
, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.
To release a new version, update the version number in version.rb
, build the gem and push the .gem
file to rubygems.org.
rake publish
rake clean
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/cmdlet. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Cmdlet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Copyright
Copyright (c) David Cruwys. See MIT License for further details.