Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hanami/cli

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

Last synced: 4 days ago
JSON representation

Hanami command line

Host: GitHub
URL: https://github.com/hanami/cli
Owner: hanami
License: mit
Created: 2021-03-11T15:15:52.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-10-29T11:58:53.000Z (5 days ago)
Last Synced: 2024-10-29T13:33:12.004Z (5 days ago)
Language: Ruby
Size: 758 KB
Stars: 27
Watchers: 12
Forks: 28
Open Issues: 30
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-ruby - Hanami CLI - General purpose Command Line Interface (CLI) framework for Ruby. (CLI Builder)

README

# Hanami::CLI

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.

## Status

[![Gem Version](https://badge.fury.io/rb/hanami-cli.svg)](https://badge.fury.io/rb/hanami-cli)
[![CI](https://github.com/hanami/cli/actions/workflows/ci.yml/badge.svg)](https://github.com/hanami/cli/actions?query=workflow%3Aci+branch%3Amain)
[![Depfu](https://badges.depfu.com/badges/a8545fb67cf32a2c75b6227bc0821027/overview.svg)](https://depfu.com/github/hanami/cli?project=Bundler)

## 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](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).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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