Skip to content

jclyons/berkshelf

 
 

Repository files navigation

Berkshelf

Gem Version Build Status Dependency Status Code Climate

Manage a Cookbook or an Application's Cookbook dependencies

Installation

Add Berkshelf to your repository's Gemfile:

gem 'berkshelf'

Or run it as a standalone:

gem install berkshelf

Usage

See berkshelf.com for up-to-date usage instructions.

Supported Platforms

Berkshelf is tested on Ruby 1.9.3, 2.0.0, and JRuby 1.6+.

Ruby 1.9 mode is required on all interpreters.

Ruby 1.9.1 and 1.9.2 are not officially supported. If you encounter problems, please upgrade to Ruby 2.0 or 1.9.3.

Bash Completion

There is a berkshelf bash completion script. If you're using homebrew, you can install it like this:

brew install bash-completion # if you haven't already

Download the latest script

cd `brew --prefix`/etc/bash_completion.d && wget https://raw.github.com/RiotGames/berkshelf/master/berkshelf-complete.sh

And make sure you have this in your bash/zsh profile:

[ -f `brew --prefix`/etc/bash_completion ] && source `brew --prefix`/etc/bash_completion

Plugins

Please see Plugins page for more information.

Configuration

Berkshelf will search in specific locations for a configuration file. In order:

$PWD/.berkshelf/config.json
$PWD/berkshelf/config.json
$PWD/berkshelf-config.json
$PWD/config.json
~/.berkshelf/config.json

You are encouraged to keep project-specific configuration in the $PWD/.berkshelf directory. You can generate a project-configuration file by running:

$ berks configure --path ./.berkshelf/config.json

SSL Errors

If you have trouble getting Berkshelf to successfully talk to an SSL Chef Server, you can try making sure you have a certificate bundle available to your shell. export SSL_CERT_FILE=...path/to/cert/file...

If you need to disable SSL, you can in ~/.berkshelf/config.json like so:

{
  "ssl": {
    "verify": false
  }
}

Authors

Thank you to all of our Contributors, testers, and users.

If you'd like to contribute, please see our contribution guidelines first.