Octokitchen

Octokitchen is a nifty little utility for writing small scripts for GitHub!

Add this line to your application's Gemfile:

gem 'octokitchen'

And then execute:

$ bundle

Or install it yourself as:

$ gem install octokitchen

Usage:
  octokitchen [OPTIONS] <NAME> [<DIRECTORY>]

Options:
  -g, [--gemfile], [--no-gemfile]    # Whether or not the script should use a Gemfile, defaults to `no-gemfile`
      [--dependencies=DEPENDENCIES]  # comma-separated list of dependencies
      [--command=COMMAND]            # What the name of the command/filename should be. Defaults to an underscored version of the script name.

Generate a new GitHub script

If you're using git and in a git project directory when you run octokitchen, the generated README will automatically contain git cloning information based off of whichever remote you have set to origin.

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.

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/kylemacey/octokitchen. 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.

The gem is available as open source under the terms of the MIT License.