https://github.com/hanami/hanami-cli

Hanami command line
https://github.com/hanami/hanami-cli

Last synced: 3 months ago
JSON representation

Hanami command line

• Host: GitHub
• URL: https://github.com/hanami/hanami-cli
• Owner: hanami
• License: mit
• Created: 2021-03-11T15:15:52.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2026-01-25T05:54:36.000Z (4 months ago)
• Last Synced: 2026-01-25T20:32:09.326Z (4 months ago)
• Language: Ruby
• Size: 1.44 MB
• Stars: 31
• Watchers: 10
• Forks: 47
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

README

          


[rubygem]: https://rubygems.org/gems/hanami-cli

[actions]: https://github.com/hanami/hanami-cli/actions

# Hanami CLI [![Gem Version](https://badge.fury.io/rb/hanami-cli.svg)][rubygem] [![CI Status](https://github.com/hanami/hanami-cli/workflows/CI/badge.svg)][actions]

This library contains all of the CLI commands for [full-stack Hanami applications](`https://github.com/hanami/hanami`).

**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](https://github.com/dry-rb/dry-cli).

Please update your Gemfiles accordingly.

## Installation

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](https://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](https://github.com/hanami/cli/blob/main/CODE_OF_CONDUCT.md).

## Links

- [User documentation](https://hanamirb.org)

- [API documentation](http://rubydoc.info/gems/hanami-cli)

## License

See `LICENSE` file.