1BUNDLE-GEM(1)                                                    BUNDLE-GEM(1)
2
3
4

NAME

6       bundle-gem - Generate a project skeleton for creating a rubygem
7

SYNOPSIS

9       bundle gem GEM_NAME OPTIONS
10

DESCRIPTION

12       Generates a directory named GEM_NAME with a Rakefile, GEM_NAME.gemspec,
13       and other supporting files and directories that can be used to  develop
14       a rubygem with that name.
15
16       Run  rake -T in the resulting project for a list of Rake tasks that can
17       be used to test and publish the gem to rubygems.org.
18
19       The generated project skeleton  can  be  customized  with  OPTIONS,  as
20       explained  below.  Note  that  these  options can also be specified via
21       Bundler´s global configuration file using the following names:
22
23       ·   gem.coc
24
25       ·   gem.mit
26
27       ·   gem.test
28
29
30

OPTIONS

32       --exe or -b or --bin
33              Specify that Bundler  should  create  a  binary  executable  (as
34              exe/GEM_NAME) in the generated rubygem project. This binary will
35              also be added to the GEM_NAME.gemspec manifest. This behavior is
36              disabled by default.
37
38       --no-exe
39              Do  not create a binary (overrides --exe specified in the global
40              config).
41
42       --coc  Add a CODE_OF_CONDUCT.md file  to  the  root  of  the  generated
43              project.  If  this  option is unspecified, an interactive prompt
44              will be displayed and the answer  will  be  saved  in  Bundler´s
45              global config for future bundle gem use.
46
47       --no-coc
48              Do not create a CODE_OF_CONDUCT.md (overrides --coc specified in
49              the global config).
50
51       --ext  Add boilerplate for C extension code to the  generated  project.
52              This behavior is disabled by default.
53
54       --no-ext
55              Do  not  add  C extension code (overrides --ext specified in the
56              global config).
57
58       --mit  Add an MIT license to a LICENSE.txt file in the root of the gen‐
59              erated project. Your name from the global git config is used for
60              the copyright statement.  If  this  option  is  unspecified,  an
61              interactive  prompt  will  be  displayed  and the answer will be
62              saved in Bundler´s global config for future bundle gem use.
63
64       --no-mit
65              Do not create a LICENSE.txt (overrides --mit  specified  in  the
66              global config).
67
68       -t, --test=minitest, --test=rspec
69              Specify the test framework that Bundler should use when generat‐
70              ing the project. Acceptable values are minitest and  rspec.  The
71              GEM_NAME.gemspec  will  be  configured  and a skeleton test/spec
72              directory will be created based on this option. If  this  option
73              is  unspecified, an interactive prompt will be displayed and the
74              answer will be saved in Bundler´s global config for future  bun‐
75              dle  gem  use.  If  no  option is specified, the default testing
76              framework is RSpec.
77
78       -e, --edit[=EDITOR]
79              Open the resulting GEM_NAME.gemspec in EDITOR,  or  the  default
80              editor  if  not specified. The default is $BUNDLER_EDITOR, $VIS‐
81              UAL, or $EDITOR.
82

SEE ALSO

84       ·   bundle config(1) bundle-config.1.html
85
86
87
88
89
90
91                                 January 2020                    BUNDLE-GEM(1)
Impressum