Hanami::CLI

This library contains all of the CLI commands for full-stack Hanami applications.

NOTE: For versions 0.4 and below, there was a general purpose CLI utility library with this name. That library has since been renamed to dry-rb/dry-cli. Please update your Gemfiles accordingly.

Status

Contact

Home page: http://hanamirb.org
Mailing List: http://hanamirb.org/mailing-list
Bugs/Issues: https://github.com/hanami/cli/issues
API Doc: http://rubydoc.info/gems/hanami-cli
Chat: http://chat.hanamirb.org

Installation

Hanami::CLI supports Ruby (MRI) 3.1+

This library is a dependency of the main hanami gem, so installing that is the best way to get and use this gem.

Usage

Development

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.

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 the created tag, and push the .gem file to rubygems.org.

In order to run all of the tests, you should run docker compose up separately, to run a postgres server.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/hanami/cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 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 Hanami::CLI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.