<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>knife-cookbook-site(1) - Install and update open source cookbooks</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
<style type='text/css' media='all'>
/* style: toc */
.man-navigation {display:block !important;position:fixed;top:0;left:113ex;height:100%;width:100%;padding:48px 0 0 0;border-left:1px solid #dbdbdb;background:#eee}
.man-navigation a,.man-navigation a:hover,.man-navigation a:link,.man-navigation a:visited {display:block;margin:0;padding:5px 2px 5px 30px;color:#999;text-decoration:none}
.man-navigation a:hover {color:#111;text-decoration:underline}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#COOKBOOK-SITE-SUB-COMMANDS">COOKBOOK SITE SUB-COMMANDS</a>
<a href="#INSTALL">INSTALL</a>
<a href="#DOWNLOAD">DOWNLOAD</a>
<a href="#LIST">LIST</a>
<a href="#SEARCH">SEARCH</a>
<a href="#SHARE">SHARE</a>
<a href="#UNSHARE">UNSHARE</a>
<a href="#SHOW">SHOW</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#EXAMPLES">EXAMPLES</a>
<a href="#SEE-ALSO">SEE ALSO</a>
<a href="#AUTHOR">AUTHOR</a>
<a href="#DOCUMENTATION">DOCUMENTATION</a>
<a href="#CHEF">CHEF</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>knife-cookbook-site(1)</li>
<li class='tc'>Chef Manual</li>
<li class='tr'>knife-cookbook-site(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>knife-cookbook-site</code> - <span class="man-whatis">Install and update open source cookbooks</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p><strong>knife</strong> <strong>cookbook site</strong> <em>sub-command</em> <em>(options)</em></p>
<h2 id="COOKBOOK-SITE-SUB-COMMANDS">COOKBOOK SITE SUB-COMMANDS</h2>
<p><code>knife cookbook site</code> provides the following subcommands:</p>
<h2 id="INSTALL">INSTALL</h2>
<p><strong>cookbook site install COOKBOOK [VERSION]</strong> <em>(options)</em></p>
<dl>
<dt><code>-D</code>, <code>--skip-dependencies</code></dt><dd>Skip automatic installation of dependencies.</dd>
<dt><code>-o</code>, <code>--cookbook-path PATH</code></dt><dd>Install cookbooks to PATH</dd>
<dt><code>-B</code>, <code>--branch BRANCH</code></dt><dd>Default branch to work with [defaults to master]</dd>
</dl>
<p>Uses <span class="man-ref">git<span class="s">(1)</span></span> version control in conjunction with the cookbook site to
install community contributed cookbooks to your local cookbook
repository. Running <code>knife cookbook site install</code> does the following:</p>
<ol>
<li>A new "pristine copy" branch is created in git for tracking the
upstream;</li>
<li>All existing cookbooks are removed from the branch;</li>
<li>The cookbook is downloaded from the cookbook site in tarball form;</li>
<li>The downloaded cookbook is untarred, and its contents commited via git;</li>
<li>The pristine copy branch is merged into the master branch.</li>
</ol>
<p>By installing cookbook with this process, you can locally modify the
upstream cookbook in your master branch and let git maintain your
changes as a separate patch. When an updated upstream version becomes
available, you will be able to merge the upstream changes while
maintaining your local modifications.</p>
<p>Unless <em>--skip-dependencies</em> is specified, the process is applied recursively to all the
cookbooks <em>COOKBOOK</em> depends on (via metadata <em>dependencies</em>).</p>
<h2 id="DOWNLOAD">DOWNLOAD</h2>
<p><strong>knife cookbook site download COOKBOOK [VERSION]</strong> <em>(options)</em></p>
<dl>
<dt><code>-f</code>, <code>--file FILE</code></dt><dd>The filename to write to</dd>
<dt class="flush"><code>--force</code></dt><dd>Force download deprecated cookbook</dd>
</dl>
<p>Downloads a specific cookbook from the Community site, optionally
specifying a certain version.</p>
<h2 id="LIST">LIST</h2>
<p><strong>knife cookbook site list</strong> <em>(options)</em></p>
<dl>
<dt><code>-w</code>, <code>--with-uri</code></dt><dd>Show corresponding URIs</dd>
</dl>
<p>Lists available cookbooks from the Community site.</p>
<h2 id="SEARCH">SEARCH</h2>
<p><strong>knife cookbook site search QUERY</strong> <em>(options)</em></p>
<p>Searches for available cookbooks matching the specified query.</p>
<h2 id="SHARE">SHARE</h2>
<p><strong>knife cookbook site share COOKBOOK CATEGORY</strong> <em>(options)</em></p>
<dl>
<dt><code>-k</code>, <code>--key KEY</code></dt><dd>API Client Key</dd>
<dt><code>-u</code>, <code>--user USER</code></dt><dd>API Client Username</dd>
<dt><code>-o</code>, <code>--cookbook-path PATH:PATH</code></dt><dd>A colon-separated path to look for cookbooks in</dd>
</dl>
<p>Uploads the specified cookbook using the given category to the Opscode
cookbooks site. Requires a login user and certificate for the Opscode
Cookbooks site. By default, knife will use the username and API key
you've configured in your configuration file; otherwise you must
explicitly set these values on the command line or use an alternate
configuration file.</p>
<h2 id="UNSHARE">UNSHARE</h2>
<p><strong>knife cookbook site unshare COOKBOOK</strong></p>
<p>Stops sharing the specified cookbook on the Opscode cookbooks site.</p>
<h2 id="SHOW">SHOW</h2>
<p><strong>knife cookbook site show COOKBOOK [VERSION]</strong> <em>(options)</em></p>
<p>Shows information from the site about a particular cookbook.</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>The cookbook site, <a href="http://community.opscode.com/" data-bare-link="true">http://community.opscode.com/</a>, is a cookbook
distribution service operated by Opscode. This service provides users
with a central location to publish cookbooks for sharing with other
community members.</p>
<p><code>knife cookbook site</code> commands provide an interface to the cookbook
site's HTTP API. For commands that read data from the API, no account is
required. In order to upload cookbooks using the <code>knife cookbook site
share</code> command, you must create an account on the cookbook site and
configure your credentials via command line option or in your knife
configuration file.</p>
<h2 id="EXAMPLES">EXAMPLES</h2>
<p>Uploading cookbooks to the Opscode cookbooks site:</p>
<pre><code>knife cookbook site share example Other -k ~/.chef/USERNAME.pem -u USERNAME
</code></pre>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p> <strong><span class="man-ref">knife-cookbook<span class="s">(1)</span></span></strong>
<a href="http://community.opscode.com/cookbooks" data-bare-link="true">http://community.opscode.com/cookbooks</a></p>
<h2 id="AUTHOR">AUTHOR</h2>
<p> Chef was written by Adam Jacob <a href="mailto:adam@opscode.com" data-bare-link="true">adam@opscode.com</a> with many contributions from the community.</p>
<h2 id="DOCUMENTATION">DOCUMENTATION</h2>
<p> This manual page was written by Joshua Timberman <a href="mailto:joshua@opscode.com" data-bare-link="true">joshua@opscode.com</a>.
Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2.0 License.</p>
<h2 id="CHEF">CHEF</h2>
<p> Knife is distributed with Chef. <a href="http://wiki.opscode.com/display/chef/Home" data-bare-link="true">http://wiki.opscode.com/display/chef/Home</a></p>
<ol class='man-decor man-foot man foot'>
<li class='tl'>Chef 10.12.0.rc.1</li>
<li class='tc'>May 2012</li>
<li class='tr'>knife-cookbook-site(1)</li>
</ol>
</div>
</body>
</html>