hanami-cli 0.2.0 → 2.0.0.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 044e34cdce8dfde02f57f2f3fbe10ea692b8461a22a0bdf0b68c1c52da00e7cb
-  data.tar.gz: 918fae86bce89456402f4adf519b94368f2d715b873fa0ea00df4b8b561dc2d8
+  metadata.gz: 9de5812f665993e5c2ef2df77e3bee3f78c0917b3089f2bb822b0eab04e2d8e7
+  data.tar.gz: 1cc451a367b2ecd1959b30604808d99efb39a819bba9726e7f0f3ef0dc98dd6d
 SHA512:
-  metadata.gz: 44baad40e044c7139753fab32c25ce821478888c01ac4a17626fe8be10797d80181a8915e135fd714f301e5b1deb9aca2cb154183f3fbca327eb5407230a36b1
-  data.tar.gz: 4a2fe7be25963816e6970fa0ae3e6fdd6d0c030313303efa60ae76e88a90cb1c357809d13823f2a258bbd99bff2ce67b59449d311f332ee05cf5d301a32934b3
+  metadata.gz: 8ff9f2bf4104febfee8cdcd230fcd56b6bb54c18651cd0c1e8acfa58ebb216ec70060e7e4ea331b11bd56c67f8236b6f48ad212a514c28489a0cfa19acc5e761
+  data.tar.gz: 304bf695102705acb0fbc1f64729c6111ffd3aa464770854826c6554e2e8a48ed8b12028f353b123e05951570e871468f98db3b4547fe7440f20381503e551ca

data/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: ci
+
+"on":
+  push:
+    paths:
+      - ".github/workflows/ci.yml"
+      - "lib/**"
+      - "*.gemspec"
+      - "spec/**"
+      - "Rakefile"
+      - "Gemfile"
+      - ".rubocop.yml"
+  pull_request:
+    branches:
+      - master
+  create:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.0"
+          - "2.7"
+          - "2.6"
+    steps:
+      - uses: actions/checkout@v1
+      - name: Install package dependencies
+        run: "[ -e $APT_DEPS ] || sudo apt-get install -y --no-install-recommends $APT_DEPS"
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+      - name: Install latest bundler
+        run: |
+          gem install bundler --no-document
+      - name: Bundle install
+        run: bundle install --jobs 4 --retry 3
+      - name: Run all tests
+        run: bundle exec rake spec

data/.gitignore

@@ -1,11 +1,13 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-.byebug_history
 .rubocop-*
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -1,2 +1,3 @@
+--format documentation
 --color
 --require spec_helper

data/.rubocop.yml

@@ -1,4 +1,28 @@
 # Please keep AllCops, Bundler, Style, Metrics groups and then order cops
 # alphabetically
+AllCops:
+  SuggestExtensions: false
 inherit_from:
-  - https://raw.githubusercontent.com/hanami/devtools/master/.rubocop.yml
+  - https://raw.githubusercontent.com/hanami/devtools/master/.rubocop-unstable.yml
+Layout/LineLength:
+  Exclude:
+    - Gemfile
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+Naming/MethodParameterName:
+  AllowedNames:
+    - fs
+Style/AccessorGrouping:
+  Enabled: false
+Style/BlockDelimiters:
+  Enabled: false
+Style/CommentedKeyword:
+  Enabled: false
+Style/LambdaCall:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Hanami::CLI
-General purpose Command Line Interface (CLI) framework for Ruby
+Hanami Command Line Interface
+
+## v2.0.0.alpha2 - 2021-05-04
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 3.0
+- [Luca Guidi] Dynamically change the set of available commands depending on the context (outside or inside an Hanami app)
+- [Luca Guidi] Dynamically change the set of available commands depending on Hanami app architecture
+- [Luca Guidi] Implemented `hanami version` (available both outside and inside an Hanami app)
+- [Piotr Solnica] Implemented `db *` commands (available both outside and inside an Hanami app) (sqlite and postgres only for now)
+- [Piotr Solnica] Implemented `console` command with support for `IRB` and `Pry` (`pry` is auto-detected)
+
+### Changed
+- [Luca Guidi] Changed the purpose of this gem: the CLI Ruby framework has been extracted into `dry-cli` gem. `hanami-cli` is now the `hanami` command line.
+- [Luca Guidi] Drop support for Ruby: MRI 2.5.
+
+## v1.0.0.alpha1 - 2019-01-30
+### Added
+- [Luca Guidi] Inheritng from subclasses of `Hanami::CLI::Command`, allows to inherit arguments, options, description, and examples.
+- [Luca Guidi] Allow to use `super` from `#call`
+
+### Changed
+- [Luca Guidi] Drop support for Ruby: MRI 2.3, and 2.4.
+
+## v0.3.1 - 2019-01-18
+### Added
+- [Luca Guidi] Official support for Ruby: MRI 2.6
+- [Luca Guidi] Support `bundler` 2.0+
+
+## v0.3.0 - 2018-10-24
+
+## v0.3.0.beta1 - 2018-08-08
+### Added
+- [Anton Davydov & Alfonso Uceda] Introduce array type for arguments (`foo exec test spec/bookshelf/entities spec/bookshelf/repositories`)
+- [Anton Davydov & Alfonso Uceda] Introduce array type for options (`foo generate config --apps=web,api`)
+- [Alfonso Uceda] Introduce variadic arguments (`foo run ruby:latest -- ruby -v`)
+- [Luca Guidi] Official support for JRuby 9.2.0.0
+
+### Fixed
+- [Anton Davydov] Print informative message when unknown or wrong option is passed (`"test" was called with arguments "--framework=unknown"`)
 
 ## v0.2.0 - 2018-04-11
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at me@lucaguidi.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,11 +1,18 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 gemspec
 
-unless ENV['TRAVIS']
-  gem 'byebug', require: false, platforms: :mri
-  gem 'yard',   require: false
+unless ENV["CI"]
+  gem "byebug", require: false, platforms: :mri
+  gem "yard",   require: false
 end
 
-gem 'hanami-utils', '~> 1.2', require: false, git: 'https://github.com/hanami/utils.git', branch: 'develop'
+gem "hanami", require: false, git: "https://github.com/hanami/hanami.git", branch: "unstable"
+gem "hanami-view", require: false, git: "https://github.com/hanami/view.git", branch: "unstable"
+
+gem "rack"
 
-gem 'hanami-devtools', require: false, git: 'https://github.com/hanami/devtools.git'
+group :test do
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Luca Guidi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,223 +1,18 @@
 # Hanami::CLI
 
-General purpose Command Line Interface (CLI) framework for Ruby.
-
-:warning: **This is a general framework for Ruby (aka `thor` gem replacement), NOT the implementation of the `hanami` CLI commands** :warning:
-
-<!-- Tocer[start]: Auto-generated, don't remove. -->
-
-## Table of Contents
-
-  - [Features](#features)
-    - [Registration](#registration)
-    - [Commands as objects](#commands-as-objects)
-    - [Subcommands](#subcommands)
-    - [Arguments](#arguments)
-    - [Option](#option)
-  - [Installation](#installation)
-  - [Usage](#usage)
-    - [Available commands](#available-commands)
-    - [Help](#help)
-    - [Optional arguments](#optional-arguments)
-    - [Required arguments](#required-arguments)
-    - [Options](#options)
-    - [Boolean options](#boolean-options)
-    - [Subcommands](#subcommands-1)
-    - [Aliases](#aliases)
-    - [Subcommand aliases](#subcommand-aliases)
-    - [Callbacks](#callbacks)
-  - [Development](#development)
-  - [Contributing](#contributing)
-  - [Alternatives](#alternatives)
-  - [Copyright](#copyright)
-
-<!-- Tocer[finish]: Auto-generated, don't remove. -->
-
-## Features
-
-### Registration
-
-For a given _command name_, you can register a corresponding _command object_ (aka command).
-
-Example: for `foo hi` _command name_ there is the corresponding `Foo::CLI::Hello` _command object_.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Hello < Hanami::CLI::Command
-        def call(*)
-        end
-      end
-    end
-  end
-end
-
-class Version < Hanami::CLI::Command
-  def call(*)
-  end
-end
-
-Foo::CLI::Commands.register "hi", Foo::CLI::Commands::Hello
-Foo::CLI::Commands.register "v",  Version
-
-Hanami::CLI.new(Foo::CLI::Commands).call
-```
-
-**Please note:** there is NOT a convention between the _command name_ and the _command object_ class.
-The manual _registration_ assigns a _command object_ to a _command name_.
-
-### Commands as objects
-
-A command is a subclass of `Hanami::CLI::Command` and it MUST respond to `#call(*)`.
-
-### Subcommands
-
-There is nothing special in subcommands: they are just _command objects_ registered under a **nested** _command name_.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      module Generate
-        class Configuration < Hanami::CLI::Command
-          def call(*)
-          end
-        end
-      end
-    end
-  end
-end
-
-Foo::CLI::Commands.register "generate configuration", Foo::CLI::Commands::Generate::Configuration
-
-Hanami::CLI.new(Foo::CLI::Commands).call
-```
-
-### Arguments
-
-An argument is a token passed after the _command name_.
-For instance, given the `foo greet` command, when an user types `foo greet Luca`, then `Luca` is considered an argument.
-A command can accept none or many arguments.
-An argument can be declared as _required_.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Greet < Hanami::CLI::Command
-        argument :name, required: true, desc: "The name of the person to greet"
-        argument :age, desc: "The age of the person to greet"
-
-        def call(name:, age: nil, **)
-          result = "Hello, #{name}."
-          result = "#{result} You are #{age} years old." unless age.nil?
-
-          puts result
-        end
-      end
-
-      register "greet", Greet
-    end
-  end
-end
-
-Hanami::CLI.new(Foo::CLI::Commands).call
-```
-
-```shell
-% foo greet Luca
-Hello, Luca.
-```
-
-```shell
-% foo greet Luca 35
-Hello, Luca. You are 35 years old.
-```
-
-```shell
-% foo greet
-ERROR: "foo greet" was called with no arguments
-Usage: "foo greet NAME"
-```
-
-### Option
-
-An option is a named argument that is passed after the _command name_ **and** the arguments.
-
-For instance, given the `foo request` command, when an user types `foo request --mode=http2`, then `--mode=http2` is considered an option.
-A command can accept none or many options.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Request < Hanami::CLI::Command
-        option :mode, default: "http", values: %w[http http2], desc: "The request mode"
-
-        def call(**options)
-          puts "Performing a request (mode: #{options.fetch(:mode)})"
-        end
-      end
-
-      register "request", Request
-    end
-  end
-end
-
-Hanami::CLI.new(Foo::CLI::Commands).call
-```
-
-```shell
-% foo request
-Performing a request (mode: http)
-```
-
-```shell
-% foo request --mode=http2
-Performing a request (mode: http2)
-```
-
-```shell
-% foo request --mode=unknown
-Error: Invalid param provided
-```
+[Hanami](http://hanamirb.org) command line
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "hanami-cli"
+gem 'hanami-cli'
 ```
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -225,294 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-Imagine to build a CLI executable `foo` for your Ruby project.
-
-```ruby
-#!/usr/bin/env ruby
-require "bundler/setup"
-require "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Version < Hanami::CLI::Command
-        desc "Print version"
-
-        def call(*)
-          puts "1.0.0"
-        end
-      end
-
-      class Echo < Hanami::CLI::Command
-        desc "Print input"
-
-        argument :input, desc: "Input to print"
-
-        example [
-          "             # Prints 'wuh?'",
-          "hello, folks # Prints 'hello, folks'"
-        ]
-
-        def call(input: nil, **)
-          if input.nil?
-            puts "wuh?"
-          else
-            puts input
-          end
-        end
-      end
-
-      class Start < Hanami::CLI::Command
-        desc "Start Foo machinery"
-
-        argument :root, required: true, desc: "Root directory"
-
-        example [
-          "path/to/root # Start Foo at root directory"
-        ]
-
-        def call(root:, **)
-          puts "started - root: #{root}"
-        end
-      end
-
-      class Stop < Hanami::CLI::Command
-        desc "Stop Foo machinery"
-
-        option :graceful, type: :boolean, default: true, desc: "Graceful stop"
-
-        def call(**options)
-          puts "stopped - graceful: #{options.fetch(:graceful)}"
-        end
-      end
-
-      module Generate
-        class Configuration < Hanami::CLI::Command
-          desc "Generate configuration"
-
-          def call(*)
-            puts "generated configuration"
-          end
-        end
-
-        class Test < Hanami::CLI::Command
-          desc "Generate tests"
-
-          option :framework, default: "minitest", values: %w[minitest rspec]
-
-          def call(framework:, **)
-            puts "generated tests - framework: #{framework}"
-          end
-        end
-      end
-
-      register "version", Version, aliases: ["v", "-v", "--version"]
-      register "echo",    Echo
-      register "start",   Start
-      register "stop",    Stop
-
-      register "generate", aliases: ["g"] do |prefix|
-        prefix.register "config", Generate::Configuration
-        prefix.register "test",   Generate::Test
-      end
-    end
-  end
-end
-
-Hanami::CLI.new(Foo::CLI::Commands).call
-```
-
-Let's have a look at the command line usage.
-
-### Available commands
-
-```shell
-% foo
-Commands:
-  foo echo [INPUT]                       # Print input
-  foo generate [SUBCOMMAND]
-  foo start ROOT                         # Start Foo machinery
-  foo stop                               # Stop Foo machinery
-  foo version                            # Print version
-```
-
-### Help
-
-```shell
-% foo echo --help
-Command:
-  foo echo
-
-Usage:
-  foo echo [INPUT]
-
-Description:
-  Print input
-
-Arguments:
-  INPUT               	# Input to print
-
-Options:
-  --help, -h                      	# Print this help
-
-Examples:
-  foo echo              # Prints 'wuh?'
-  foo echo hello, folks # Prints 'hello, folks'
-```
-
-### Optional arguments
-
-```shell
-% foo echo
-wuh?
-
-% foo echo hello
-hello
-```
-
-### Required arguments
-
-```shell
-% foo start .
-started - root: .
-```
-
-```shell
-% foo start
-ERROR: "foo start" was called with no arguments
-Usage: "foo start ROOT"
-```
-
-### Options
-
-```shell
-% foo generate test
-generated tests - framework: minitest
-```
-
-```shell
-% foo generate test --framework=rspec
-generated tests - framework: rspec
-```
-
-```shell
-% foo generate test --framework=unknown
-Error: Invalid param provided
-```
-
-### Boolean options
-
-```shell
-% foo stop
-stopped - graceful: true
-```
-
-```shell
-% foo stop --no-graceful
-stopped - graceful: false
-```
-
-### Subcommands
-
-```shell
-% foo generate
-Commands:
-  foo generate config           # Generate configuration
-  foo generate test             # Generate tests
-```
-
-### Aliases
-
-```shell
-% foo version
-1.0.0
-```
-
-```shell
-% foo v
-1.0.0
-```
-
-```shell
-% foo -v
-1.0.0
-```
-
-```shell
-% foo --version
-1.0.0
-```
-
-### Subcommand aliases
-
-```shell
-% foo g config
-generated configuration
-```
-
-### Callbacks
-
-Third party gems can register _before_ and _after_ callbacks to enhance a command.
-
-From the `foo` gem we have a command `hello`.
-
-```ruby
-#!/usr/bin/env ruby
-require "hanami/cli"
-
-module Foo
-  module CLI
-    module Commands
-      extend Hanami::CLI::Registry
-
-      class Hello < Hanami::CLI::Command
-        argument :name, required: true
-
-        def call(name:, **)
-          puts "hello #{name}"
-        end
-      end
-    end
-  end
-end
-
-Foo::CLI::Commands.register "hello", Foo::CLI::Commands::Hello
-
-cli = Hanami::CLI.new(Foo::CLI::Commands)
-cli.call
-```
-
-The `foo-bar` gem enhances `hello` command with callbacks:
-
-```
-Foo::CLI::Commands.before("hello") { |args| puts "debug: #{args.inspect}" } # syntax 1
-Foo::CLI::Commands.after "hello", &->(args) { puts "bye, #{args.fetch(:name)}" } # syntax 2
-```
-
-```shell
-% foo hello Anton
-debug: {:name=>"Anton"}
-hello Anton
-bye, Anton
-```
-
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/hanami/cli.
+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).
 
-## Alternatives
+## Code of Conduct
 
-  * [thor](http://whatisthor.com/)
-  * [clamp](https://github.com/mdub/clamp)
+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).
 
 ## Copyright
 
-Copyright © 2017 Luca Guidi – Released under MIT License
+Copyright © 2014-2021 Luca Guidi – Released under MIT License