Renuo CLI
The Renuo command line. Used for various Renuo tasks
Installation
gem install renuo-cli
Usage
renuo -h
Shell Autocompletion
To enable zsh autocompletion for renuo-cli commands:
renuo setup-autocompletion
This will install the completion script and provide instructions to add it to your shell configuration.
Development
After checking out the repo, run bin/setup to install dependencies.
Run rake spec to run the tests.
Run bundle exec ruby -Ilib ./bin/renuo to run the executable. (e.g. ruby -Ilib ./bin/renuo -v)
You can also run bin/console for an interactive prompt that will allow you to experiment.
Testing commands in the shell
The easiest way to test the CLI during development is to temporarily add the local bin directory to your PATH:
export PATH="$PWD/bin:$PATH"
This binds the renuo command to your local version, so you can run commands directly:
renuo -h
renuo generate_github_settings
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.
Release
- Bump the version number in
lib/renuo/cli/version.rb, runbundle installto update theGemfile.lockand commit tomain
Automatic
- Deploy through Semaphore console by starting a promotion to main
Manual
gem build renuo-cli.gemspec
gem push renuo-cli-*.gem
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/renuo/renuo-cli. 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.