Docs header transparent bg

bundle gem

Creates a skeleton for creating a rubygem
$ bundle gem GEM [--bin or -b] [--test=TESTFRAMEWORK] [--edit=TEXTEDITOR] [--ext]


--bin or -b: Generate a binary for your library.

--coc: Generate a code of conduct file.

--edit: Open generated gemspec in the specified editor (defaults to $EDITOR or $BUNDLER_EDITOR)

--ext: Generate a skeleton for a C-extension.

--mit: Generate an MIT license file.

--test: Generate a test directory for your library: rspec is the default, but minitest is also supported.

When run for the first time, bundle gem will ask for your preferences regarding test framework, code of conduct, and MIT license. These preferences will be stored in ~/.bundle/config for future runs.

The generated project will contain all the necessary boilerplate, including a README and a gemspec template. Also included will be a Rakefile with tasks suitable for gem development:
$ rake -T
rake build          # Build GEM-0.1.0.gem into the pkg directory
rake install        # Build and install GEM-0.1.0.gem into system gems
rake install:local  # Build and install GEM-0.1.0.gem into system gems without network access
rake release        # Create tag v0.1.0 and build and push GEM-0.1.0.gem to Rubygems
rake test           # Run tests
Edit this document on GitHub if you caught an error or noticed something was missing.