Skip to content

Starting a new project

technicalpickles edited this page Aug 22, 2010 · 3 revisions

Jeweler provides a generator. It requires you to [setup your name and email for git](http://github.com/guides/tell-git-your-user-name-and-email-address) and [your username and token for GitHub](http://github.com/guides/local-github-config).

This is the most basic usage:

jeweler the-perfect-gem

This will prepare a project in the ‘the-perfect-gem’ directory, setup to use Jeweler.

It also supports a number of options:

  • —create-repo: in addition to preparing a project, it create an repo up on GitHub and enable RubyGem generation
  • —testunit: generate test_helper.rb and test ready for test/unit
  • —minitest: generate test_helper.rb and test ready for minitest
  • —shoulda: generate test_helper.rb and test ready for shoulda (this is the default)
  • —rspec: generate spec_helper.rb and spec ready for rspec
  • —bacon: generate spec_helper.rb and spec ready for bacon
  • —rubyforge: setup releasing to rubyforge

Jeweler respects the JEWELER_OPTS environment variable. Want to always use RSpec, and you’re using bash? Add this to ~/.bashrc:

export JEWELER_OPTS=“—rspec”
Clone this wiki locally