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  ex‐
20       plained  below.  Note  that  these  options  can  also be specified via
21       Bundler´s global configuration file using the following names:
22
23gem.coc
24
25gem.mit
26
27gem.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  in‐
61              teractive  prompt will be displayed and the answer will be saved
62              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, --test=test-unit
69              Specify the test framework that Bundler should use when generat‐
70              ing the project.  Acceptable  values  are  minitest,  rspec  and
71              test-unit.  The GEM_NAME.gemspec will be configured and a skele‐
72              ton test/spec directory will be created based  on  this  option.
73              Given no option is specified:
74
75              When  Bundler  is configured to generate tests, this defaults to
76              Bundler´s global config setting gem.test.
77
78              When Bundler is configured to not generate tests, an interactive
79              prompt  will  be  displayed  and the answer will be used for the
80              current rubygem project.
81
82              When Bundler is unconfigured, an interactive prompt will be dis‐
83              played  and  the answer will be saved in Bundler´s global config
84              for future bundle gem use.
85
86       --ci, --ci=github, --ci=travis, --ci=gitlab, --ci=circle
87              Specify the continuous integration service that  Bundler  should
88              use  when  generating the project. Acceptable values are github,
89              travis, gitlab and circle. A configuration file will  be  gener‐
90              ated in the project directory. Given no option is specified:
91
92              When  Bundler  is configured to generate CI files, this defaults
93              to Bundler´s global config setting gem.ci.
94
95              When Bundler is configured to not generate CI files, an interac‐
96              tive  prompt  will  be displayed and the answer will be used for
97              the current rubygem project.
98
99              When Bundler is unconfigured, an interactive prompt will be dis‐
100              played  and  the answer will be saved in Bundler´s global config
101              for future bundle gem use.
102
103       -e, --edit[=EDITOR]
104              Open the resulting GEM_NAME.gemspec in EDITOR,  or  the  default
105              editor  if  not specified. The default is $BUNDLER_EDITOR, $VIS‐
106              UAL, or $EDITOR.
107

SEE ALSO

109       •   bundle config(1) bundle-config.1.html
110
111
112
113
114
115
116                                   June 2021                     BUNDLE-GEM(1)
Impressum