berkshelf 7.0.6 → 7.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (123) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +7 -7
  3. data/Rakefile +2 -2
  4. data/berkshelf.gemspec +9 -10
  5. data/bin/berks +5 -0
  6. data/lib/berkshelf.rb +2 -2
  7. data/lib/berkshelf/api_client/chef_server_connection.rb +3 -2
  8. data/lib/berkshelf/api_client/connection.rb +1 -1
  9. data/lib/berkshelf/berksfile.rb +47 -41
  10. data/lib/berkshelf/cached_cookbook.rb +6 -4
  11. data/lib/berkshelf/chef_config_compat.rb +1 -0
  12. data/lib/berkshelf/chef_repo_universe.rb +6 -4
  13. data/lib/berkshelf/cli.rb +12 -7
  14. data/lib/berkshelf/commands/shelf.rb +1 -1
  15. data/lib/berkshelf/community_rest.rb +4 -4
  16. data/lib/berkshelf/config.rb +1 -1
  17. data/lib/berkshelf/core_ext.rb +1 -1
  18. data/lib/berkshelf/core_ext/file_utils.rb +2 -2
  19. data/lib/berkshelf/dependency.rb +1 -1
  20. data/lib/berkshelf/downloader.rb +10 -3
  21. data/lib/berkshelf/errors.rb +2 -2
  22. data/lib/berkshelf/formatters/human.rb +1 -1
  23. data/lib/berkshelf/formatters/json.rb +4 -4
  24. data/lib/berkshelf/installer.rb +1 -1
  25. data/lib/berkshelf/location.rb +3 -3
  26. data/lib/berkshelf/lockfile.rb +14 -14
  27. data/lib/berkshelf/logger.rb +4 -2
  28. data/lib/berkshelf/mixin/git.rb +1 -1
  29. data/lib/berkshelf/packager.rb +2 -2
  30. data/lib/berkshelf/resolver.rb +1 -1
  31. data/lib/berkshelf/ridley_compat.rb +1 -1
  32. data/lib/berkshelf/shell.rb +1 -0
  33. data/lib/berkshelf/source.rb +6 -5
  34. data/lib/berkshelf/ssl_policies.rb +1 -3
  35. data/lib/berkshelf/thor.rb +1 -1
  36. data/lib/berkshelf/thor_ext.rb +1 -1
  37. data/lib/berkshelf/uploader.rb +11 -9
  38. data/lib/berkshelf/version.rb +1 -1
  39. data/lib/berkshelf/visualizer.rb +1 -1
  40. data/spec/config/knife.rb +1 -1
  41. data/spec/support/chef_server.rb +2 -2
  42. data/spec/support/git.rb +18 -18
  43. data/spec/support/path_helpers.rb +4 -4
  44. data/spec/tmp/berkshelf/cookbooks/dep-1.0.0/attributes/default.rb +0 -0
  45. data/spec/tmp/berkshelf/cookbooks/dep-1.0.0/files/default/file.h +0 -0
  46. data/spec/tmp/berkshelf/cookbooks/dep-1.0.0/metadata.rb +2 -0
  47. data/spec/tmp/berkshelf/cookbooks/dep-1.0.0/recipes/default.rb +0 -0
  48. data/spec/tmp/berkshelf/cookbooks/dep-1.0.0/templates/default/template.erb +0 -0
  49. data/spec/tmp/berkshelf/cookbooks/ekaf-1.0.0/attributes/default.rb +0 -0
  50. data/spec/tmp/berkshelf/cookbooks/ekaf-1.0.0/files/default/file.h +0 -0
  51. data/spec/tmp/berkshelf/cookbooks/ekaf-1.0.0/metadata.rb +3 -0
  52. data/spec/tmp/berkshelf/cookbooks/ekaf-1.0.0/recipes/default.rb +0 -0
  53. data/spec/tmp/berkshelf/cookbooks/ekaf-1.0.0/templates/default/template.erb +0 -0
  54. data/spec/tmp/berkshelf/cookbooks/fake-1.0.0/attributes/default.rb +0 -0
  55. data/spec/tmp/berkshelf/cookbooks/fake-1.0.0/files/default/file.h +0 -0
  56. data/spec/tmp/berkshelf/cookbooks/fake-1.0.0/metadata.rb +3 -0
  57. data/spec/tmp/berkshelf/cookbooks/fake-1.0.0/recipes/default.rb +0 -0
  58. data/spec/tmp/berkshelf/cookbooks/fake-1.0.0/templates/default/template.erb +0 -0
  59. data/spec/unit/berkshelf/berksfile_spec.rb +7 -7
  60. data/spec/unit/berkshelf/cli_spec.rb +1 -2
  61. data/spec/unit/berkshelf/community_rest_spec.rb +1 -1
  62. data/spec/unit/berkshelf/core_ext/file_utils_spec.rb +2 -2
  63. data/spec/unit/berkshelf/dependency_spec.rb +5 -5
  64. data/spec/unit/berkshelf/downloader_spec.rb +29 -8
  65. data/spec/unit/berkshelf/locations/base_spec.rb +1 -2
  66. data/spec/unit/berkshelf/locations/path_spec.rb +1 -2
  67. data/spec/unit/berkshelf/lockfile_spec.rb +9 -18
  68. data/spec/unit/berkshelf/ridley_compat_spec.rb +1 -1
  69. data/spec/unit/berkshelf/source_spec.rb +8 -7
  70. data/spec/unit/berkshelf/ssl_policies_spec.rb +3 -5
  71. data/spec/unit/berkshelf/uploader_spec.rb +6 -10
  72. metadata +49 -188
  73. data/.github/lock.yml +0 -1
  74. data/.gitignore +0 -30
  75. data/.rubocop.yml +0 -12
  76. data/.travis.yml +0 -73
  77. data/CHANGELOG.legacy.md +0 -307
  78. data/CHANGELOG.md +0 -1582
  79. data/CONTRIBUTING.md +0 -68
  80. data/Gemfile.lock +0 -301
  81. data/PLUGINS.md +0 -25
  82. data/README.md +0 -72
  83. data/Thorfile +0 -61
  84. data/appveyor.yml +0 -31
  85. data/docs/berkshelf_for_newcomers.md +0 -64
  86. data/features/artifactory.feature +0 -70
  87. data/features/berksfile.feature +0 -46
  88. data/features/commands/apply.feature +0 -41
  89. data/features/commands/contingent.feature +0 -47
  90. data/features/commands/info.feature +0 -141
  91. data/features/commands/install.feature +0 -646
  92. data/features/commands/list.feature +0 -78
  93. data/features/commands/outdated.feature +0 -127
  94. data/features/commands/package.feature +0 -17
  95. data/features/commands/search.feature +0 -17
  96. data/features/commands/shelf/list.feature +0 -32
  97. data/features/commands/shelf/show.feature +0 -113
  98. data/features/commands/shelf/uninstall.feature +0 -96
  99. data/features/commands/show.feature +0 -83
  100. data/features/commands/update.feature +0 -142
  101. data/features/commands/upload.feature +0 -499
  102. data/features/commands/vendor.feature +0 -154
  103. data/features/commands/verify.feature +0 -29
  104. data/features/commands/viz.feature +0 -66
  105. data/features/community_site.feature +0 -37
  106. data/features/help.feature +0 -11
  107. data/features/json_formatter.feature +0 -158
  108. data/features/lifecycle.feature +0 -378
  109. data/features/lockfile.feature +0 -378
  110. data/features/step_definitions/berksfile_steps.rb +0 -54
  111. data/features/step_definitions/chef/config_steps.rb +0 -12
  112. data/features/step_definitions/chef_server_steps.rb +0 -60
  113. data/features/step_definitions/cli_steps.rb +0 -18
  114. data/features/step_definitions/config_steps.rb +0 -46
  115. data/features/step_definitions/environment_steps.rb +0 -11
  116. data/features/step_definitions/filesystem_steps.rb +0 -286
  117. data/features/step_definitions/gem_steps.rb +0 -13
  118. data/features/step_definitions/json_steps.rb +0 -29
  119. data/features/step_definitions/utility_steps.rb +0 -11
  120. data/features/support/aruba.rb +0 -12
  121. data/features/support/env.rb +0 -77
  122. data/spec/fixtures/cookbooks/example_cookbook/.gitignore +0 -2
  123. data/spec/fixtures/cookbooks/example_cookbook/.kitchen.yml +0 -26
@@ -1,68 +0,0 @@
1
- # Contributing
2
-
3
- ## Developing
4
-
5
- If you'd like to submit a patch:
6
-
7
- 1. Fork the project.
8
- 2. Make your feature addition or bug fix.
9
- 3. Add [tests](#testing) for it. This is important so that it isn't broken in a
10
- future version unintentionally.
11
- 4. Commit. **Do not touch any unrelated code, such as the gemspec or version.**
12
- If you must change unrelated code, do it in a commit by itself, so that it
13
- can be ignored.
14
- 5. Send a pull request.
15
-
16
- ## Testing
17
-
18
- ### Install prerequisites
19
-
20
- Install git on your test system.
21
-
22
- Install the latest version of [Bundler](http://gembundler.com)
23
-
24
- $ gem install bundler
25
-
26
- Clone the project
27
-
28
- $ git clone git://github.com/berkshelf/berkshelf.git
29
-
30
- and run:
31
-
32
- $ cd berkshelf
33
- $ bundle install
34
-
35
- Bundler will install all gems and their dependencies required for testing and developing.
36
-
37
- ### Running unit (RSpec) and acceptance (Cucumber) tests
38
-
39
- We use Chef Zero - an in-memory Chef Server for running tests. It is automatically managed by the Specs and Cukes. Run:
40
-
41
- $ bundle exec guard start
42
-
43
- or
44
-
45
- $ bundle exec thor spec:ci
46
-
47
- See [here](https://github.com/tdegrunt/vagrant-chef-server-bootstrap) for a
48
- quick way to get a testing chef server up.
49
-
50
- ### Debugging Issues
51
- By default, Berkshelf will only give you the top-level output from a failed command. If you're working deep inside the core, an error like:
52
-
53
- Berkshelf Error: wrong number of arguments (2 for 1)
54
-
55
- isn't exactly helpful...
56
-
57
- Specify the `BERKSHELF_DEBUG` flag when running your command to see a full stack trace and other helpful debugging information.
58
-
59
- ## Releasing
60
-
61
- Once you are ready to release Berkshelf, perform the following:
62
-
63
- 1. Update `CHANGELOG.md` with a new header indicating the version to be released
64
- 1. Examine the diff ([example](https://github.com/berkshelf/berkshelf/compare/v4.0.1...master)) between master and the previous version. Add all merged Pull Requests to the `CHANGELOG.md`
65
- 1. Update `version.rb` to the desired release version
66
- 1. Run `bundle update berkshelf`
67
- 1. Create a PR and review the `version.rb` changes and `CHANGELOG.md` changes
68
- 1. Once the PR is merged to master, run `rake release` on the master branch
@@ -1,301 +0,0 @@
1
- GIT
2
- remote: https://github.com/chef/chef
3
- revision: 111bb019fed2eea16f43acd52635607f3a33373e
4
- branch: master
5
- specs:
6
- chef (14.4.23)
7
- addressable
8
- bundler (>= 1.10)
9
- chef-config (= 14.4.23)
10
- chef-zero (>= 13.0)
11
- diff-lcs (~> 1.2, >= 1.2.4)
12
- erubis (~> 2.7)
13
- ffi (~> 1.9, >= 1.9.25)
14
- ffi-yajl (~> 2.2)
15
- highline (~> 1.6, >= 1.6.9)
16
- iniparse (~> 1.4)
17
- iso8601 (~> 0.11.0)
18
- mixlib-archive (~> 0.4)
19
- mixlib-authentication (~> 2.1)
20
- mixlib-cli (~> 1.7)
21
- mixlib-log (~> 2.0, >= 2.0.3)
22
- mixlib-shellout (~> 2.0)
23
- net-sftp (~> 2.1, >= 2.1.2)
24
- net-ssh (~> 4.2)
25
- net-ssh-multi (~> 1.2, >= 1.2.1)
26
- ohai (~> 14.0)
27
- plist (~> 3.2)
28
- proxifier (~> 1.0)
29
- rspec-core (~> 3.5)
30
- rspec-expectations (~> 3.5)
31
- rspec-mocks (~> 3.5)
32
- rspec_junit_formatter (~> 0.2.0)
33
- serverspec (~> 2.7)
34
- specinfra (~> 2.10)
35
- syslog-logger (~> 1.6)
36
- uuidtools (~> 2.1.5)
37
- chef-config (14.4.23)
38
- addressable
39
- fuzzyurl
40
- mixlib-config (>= 2.2.12, < 3.0)
41
- mixlib-shellout (~> 2.0)
42
- tomlrb (~> 1.2)
43
-
44
- GIT
45
- remote: https://github.com/chef/chefstyle.git
46
- revision: 4a885da4a201b55f2a5568bc0ea054860ccbf3c3
47
- branch: master
48
- specs:
49
- chefstyle (0.10.0)
50
- rubocop (= 0.55.0)
51
-
52
- PATH
53
- remote: .
54
- specs:
55
- berkshelf (7.0.6)
56
- chef (>= 13.6.52)
57
- chef-config
58
- cleanroom (~> 1.0)
59
- concurrent-ruby (~> 1.0)
60
- minitar (>= 0.6)
61
- mixlib-archive (~> 0.4)
62
- mixlib-config (>= 2.2.5)
63
- mixlib-shellout (~> 2.0)
64
- octokit (~> 4.0)
65
- retryable (~> 2.0)
66
- solve (~> 4.0)
67
- thor (>= 0.20)
68
-
69
- GEM
70
- remote: https://rubygems.org/
71
- specs:
72
- activesupport (5.2.0)
73
- concurrent-ruby (~> 1.0, >= 1.0.2)
74
- i18n (>= 0.7, < 2)
75
- minitest (~> 5.1)
76
- tzinfo (~> 1.1)
77
- addressable (2.5.2)
78
- public_suffix (>= 2.0.2, < 4.0)
79
- aruba (0.14.6)
80
- childprocess (>= 0.6.3, < 0.10.0)
81
- contracts (~> 0.9)
82
- cucumber (>= 1.3.19)
83
- ffi (~> 1.9.10)
84
- rspec-expectations (>= 2.99)
85
- thor (~> 0.19)
86
- ast (2.4.0)
87
- backports (3.11.3)
88
- builder (3.2.3)
89
- chef-zero (14.0.6)
90
- ffi-yajl (~> 2.2)
91
- hashie (>= 2.0, < 4.0)
92
- mixlib-log (~> 2.0)
93
- rack (~> 2.0)
94
- uuidtools (~> 2.1)
95
- childprocess (0.9.0)
96
- ffi (~> 1.0, >= 1.0.11)
97
- cleanroom (1.0.0)
98
- concurrent-ruby (1.0.5)
99
- contracts (0.16.0)
100
- crack (0.4.3)
101
- safe_yaml (~> 1.0.0)
102
- cucumber (3.1.0)
103
- builder (>= 2.1.2)
104
- cucumber-core (~> 3.1.0)
105
- cucumber-expressions (~> 5.0.4)
106
- cucumber-wire (~> 0.0.1)
107
- diff-lcs (~> 1.3)
108
- gherkin (~> 5.0)
109
- multi_json (>= 1.7.5, < 2.0)
110
- multi_test (>= 0.1.2)
111
- cucumber-core (3.1.0)
112
- backports (>= 3.8.0)
113
- cucumber-tag_expressions (~> 1.1.0)
114
- gherkin (>= 5.0.0)
115
- cucumber-expressions (5.0.13)
116
- cucumber-tag_expressions (1.1.1)
117
- cucumber-wire (0.0.1)
118
- dep-selector-libgecode (1.3.1)
119
- dep_selector (1.0.6)
120
- dep-selector-libgecode (~> 1.0)
121
- ffi (~> 1.9)
122
- diff-lcs (1.3)
123
- domain_name (0.5.20180417)
124
- unf (>= 0.0.5, < 1.0.0)
125
- erubis (2.7.0)
126
- faraday (0.15.2)
127
- multipart-post (>= 1.2, < 3)
128
- faraday-http-cache (2.0.0)
129
- faraday (~> 0.8)
130
- ffi (1.9.25)
131
- ffi-yajl (2.3.1)
132
- libyajl2 (~> 1.2)
133
- fuubar (2.3.2)
134
- rspec-core (~> 3.0)
135
- ruby-progressbar (~> 1.4)
136
- fuzzyurl (0.9.0)
137
- gherkin (5.1.0)
138
- github_changelog_generator (1.14.3)
139
- activesupport
140
- faraday-http-cache
141
- multi_json
142
- octokit (~> 4.6)
143
- rainbow (>= 2.1)
144
- rake (>= 10.0)
145
- retriable (~> 2.1)
146
- hashdiff (0.3.7)
147
- hashie (3.5.7)
148
- highline (1.7.10)
149
- http (3.3.0)
150
- addressable (~> 2.3)
151
- http-cookie (~> 1.0)
152
- http-form_data (~> 2.0)
153
- http_parser.rb (~> 0.6.0)
154
- http-cookie (1.0.3)
155
- domain_name (~> 0.5)
156
- http-form_data (2.1.1)
157
- http_parser.rb (0.6.0)
158
- i18n (1.0.1)
159
- concurrent-ruby (~> 1.0)
160
- iniparse (1.4.4)
161
- ipaddress (0.8.3)
162
- iso8601 (0.11.0)
163
- libyajl2 (1.2.0)
164
- minitar (0.6.1)
165
- minitest (5.11.3)
166
- mixlib-archive (0.4.13)
167
- mixlib-log
168
- mixlib-authentication (2.1.1)
169
- mixlib-cli (1.7.0)
170
- mixlib-config (2.2.13)
171
- tomlrb
172
- mixlib-log (2.0.4)
173
- mixlib-shellout (2.4.0)
174
- molinillo (0.6.5)
175
- multi_json (1.13.1)
176
- multi_test (0.1.2)
177
- multipart-post (2.0.0)
178
- net-scp (1.2.1)
179
- net-ssh (>= 2.6.5)
180
- net-sftp (2.1.2)
181
- net-ssh (>= 2.6.5)
182
- net-ssh (4.2.0)
183
- net-ssh-gateway (2.0.0)
184
- net-ssh (>= 4.0.0)
185
- net-ssh-multi (1.2.1)
186
- net-ssh (>= 2.6.5)
187
- net-ssh-gateway (>= 1.2.0)
188
- net-telnet (0.2.0)
189
- octokit (4.9.0)
190
- sawyer (~> 0.8.0, >= 0.5.3)
191
- ohai (14.3.0)
192
- chef-config (>= 12.8, < 15)
193
- ffi (~> 1.9)
194
- ffi-yajl (~> 2.2)
195
- ipaddress
196
- mixlib-cli
197
- mixlib-config (~> 2.0)
198
- mixlib-log (~> 2.0, >= 2.0.1)
199
- mixlib-shellout (~> 2.0)
200
- plist (~> 3.1)
201
- systemu (~> 2.6.4)
202
- wmi-lite (~> 1.0)
203
- parallel (1.12.1)
204
- parser (2.5.1.2)
205
- ast (~> 2.4.0)
206
- plist (3.4.0)
207
- powerpack (0.1.2)
208
- proxifier (1.0.3)
209
- public_suffix (3.0.2)
210
- rack (2.0.5)
211
- rainbow (3.0.0)
212
- rake (12.3.1)
213
- retriable (2.1.0)
214
- retryable (2.0.4)
215
- rspec (3.8.0)
216
- rspec-core (~> 3.8.0)
217
- rspec-expectations (~> 3.8.0)
218
- rspec-mocks (~> 3.8.0)
219
- rspec-core (3.8.0)
220
- rspec-support (~> 3.8.0)
221
- rspec-expectations (3.8.0)
222
- diff-lcs (>= 1.2.0, < 2.0)
223
- rspec-support (~> 3.8.0)
224
- rspec-its (1.2.0)
225
- rspec-core (>= 3.0.0)
226
- rspec-expectations (>= 3.0.0)
227
- rspec-mocks (3.8.0)
228
- diff-lcs (>= 1.2.0, < 2.0)
229
- rspec-support (~> 3.8.0)
230
- rspec-support (3.8.0)
231
- rspec_junit_formatter (0.2.3)
232
- builder (< 4)
233
- rspec-core (>= 2, < 4, != 2.12.0)
234
- rubocop (0.55.0)
235
- parallel (~> 1.10)
236
- parser (>= 2.5)
237
- powerpack (~> 0.1)
238
- rainbow (>= 2.2.2, < 4.0)
239
- ruby-progressbar (~> 1.7)
240
- unicode-display_width (~> 1.0, >= 1.0.1)
241
- ruby-progressbar (1.9.0)
242
- safe_yaml (1.0.4)
243
- sawyer (0.8.1)
244
- addressable (>= 2.3.5, < 2.6)
245
- faraday (~> 0.8, < 1.0)
246
- semverse (2.0.0)
247
- serverspec (2.41.3)
248
- multi_json
249
- rspec (~> 3.0)
250
- rspec-its
251
- specinfra (~> 2.72)
252
- sfl (2.3)
253
- solve (4.0.0)
254
- molinillo (~> 0.6)
255
- semverse (>= 1.1, < 3.0)
256
- specinfra (2.75.1)
257
- net-scp
258
- net-ssh (>= 2.7)
259
- net-telnet
260
- sfl
261
- syslog-logger (1.6.8)
262
- systemu (2.6.5)
263
- thor (0.20.0)
264
- thread_safe (0.3.6)
265
- tomlrb (1.2.7)
266
- tzinfo (1.2.5)
267
- thread_safe (~> 0.1)
268
- unf (0.1.4)
269
- unf_ext
270
- unf_ext (0.0.7.5)
271
- unicode-display_width (1.4.0)
272
- uuidtools (2.1.5)
273
- webmock (3.4.2)
274
- addressable (>= 2.3.6)
275
- crack (>= 0.3.2)
276
- hashdiff
277
- wmi-lite (1.0.0)
278
- yard (0.9.15)
279
-
280
- PLATFORMS
281
- ruby
282
-
283
- DEPENDENCIES
284
- aruba (>= 0.10.0)
285
- berkshelf!
286
- chef!
287
- chef-zero (>= 4.0)
288
- chefstyle!
289
- cucumber-expressions (= 5.0.13)
290
- dep_selector (>= 1.0)
291
- fuubar (>= 2.0)
292
- github_changelog_generator
293
- http (>= 0.9.8)
294
- rake (>= 10.1)
295
- rspec (>= 3.0)
296
- rspec-its (>= 1.2)
297
- webmock (>= 1.11)
298
- yard (>= 0.8)
299
-
300
- BUNDLED WITH
301
- 1.16.1
data/PLUGINS.md DELETED
@@ -1,25 +0,0 @@
1
- Berkshelf Plugins
2
- =================
3
- This is a list of community-contributed plugins for Berkshelf. A few notes:
4
-
5
- - Please do not open issues regarding a community plugin on Berkshelf. Create the issue on the plugin first please.
6
- - Plugins are listed in alphabetical order for consistency.
7
-
8
- Plugins
9
- -------
10
- - [berkshelf-bzr](https://github.com/berkshelf/berkshelf-bzr) - Add support for downloading cookbooks from Bazaar locations.
11
- - [berkshelf-hg](https://github.com/berkshelf/berkshelf-hg) - Add support for downloading cookbooks from Mercurial locations.
12
- - [vagrant-berkshelf](https://github.com/berkshelf/vagrant-berkshelf) - A Vagrant plugin to add Berkshelf integration to the Chef provisioners.
13
-
14
- I want to add my plugin!
15
- ------------------------
16
- 1. Plugins should be prefixed with `berkshelf-` for consistency.
17
- 1. Create your plugin on github - be sure to include tests. We will most likely not list a plugin that is untested.
18
- 1. Fork the Berkshelf project on github.
19
- 1. Edit this file, adding your plugin. All plugins must be on github. The format for a plugin is:
20
-
21
- [Linked Project Name](#) - A short description of the plugin, what it does, why it exists, etc. ([Optional Link to Plugin Website](#))
22
-
23
- For example:
24
-
25
- [berkshelf-myface](https://github.com/berkshelf/berkshelf-myface) - A plugin to add myface support to Berkshelf.
data/README.md DELETED
@@ -1,72 +0,0 @@
1
- # Berkshelf
2
- [![Gem Version](https://img.shields.io/gem/v/berkshelf.svg)][gem]
3
- [![Build Status](https://img.shields.io/travis/berkshelf/berkshelf.svg)][travis]
4
-
5
- [gem]: https://rubygems.org/gems/berkshelf
6
- [travis]: https://travis-ci.org/berkshelf/berkshelf
7
-
8
- Manage a Cookbook or an Application's Cookbook dependencies
9
-
10
- ## Installation
11
-
12
- Berkshelf is now included as part of the [Chef-DK](https://downloads.chef.io/chef-dk/). This is fastest, easiest, and the recommended installation method for getting up and running with Berkshelf.
13
-
14
- > note: You may need to uninstall the Berkshelf gem especially if you are using a Ruby version manager you may need to uninstall all Berkshelf gems from each Ruby installation.
15
-
16
- ### From Rubygems
17
-
18
- If you are a developer or you prefer to install from Rubygems, we've got you covered.
19
-
20
- Add Berkshelf to your repository's `Gemfile`:
21
-
22
- ```ruby
23
- gem 'berkshelf'
24
- ```
25
-
26
- Or run it as a standalone:
27
-
28
- ```shell
29
- $ gem install berkshelf
30
- ```
31
-
32
- ## Usage
33
-
34
- See [docs.chef.io](https://docs.chef.io/berkshelf.html) for up-to-date usage instructions.
35
-
36
- ## CLI Usage
37
-
38
- Berkshelf is intended to be used as a CLI tool. It is not intended to be used as a library. Other ruby code should shell out to the command line tool to use it.
39
-
40
- ## Supported Platforms
41
-
42
- Berkshelf is tested and supported on Ruby 2.3 and 2.4.
43
-
44
- ## Configuration
45
-
46
- Berkshelf will search in specific locations for a configuration file. In order:
47
-
48
- $PWD/.berkshelf/config.json
49
- ~/.berkshelf/config.json
50
-
51
- You are encouraged to keep project-specific configuration in the `$PWD/.berkshelf` directory. A default configuration file is generated for you, but you can update the values to suit your needs.
52
-
53
- ## Shell Completion
54
-
55
- - [Bash](https://github.com/berkshelf/berkshelf-bash-plugin)
56
- - [ZSH](https://github.com/berkshelf/berkshelf-zsh-plugin)
57
-
58
- ## Plugins
59
-
60
- Please see [Plugins page](https://github.com/berkshelf/berkshelf/blob/master/PLUGINS.md) for more information.
61
-
62
- ## Getting Help
63
-
64
- * If you have an issue: report it on the [issue tracker](https://github.com/berkshelf/berkshelf/issues)
65
- * If you have a question: visit the #chef or #berkshelf channel on irc.freenode.net
66
-
67
- ## Authors
68
-
69
- Thank you to all of our [Contributors](https://github.com/berkshelf/berkshelf/graphs/contributors), testers, and users.
70
-
71
- If you'd like to contribute, please see our [contribution guidelines](https://github.com/berkshelf/berkshelf/blob/master/CONTRIBUTING.md) first.
72
-