1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "KNIFE\-COOKBOOK\-SITE" "1" "November 2014" "Chef 10.34.6" "Chef Manual"
.
.SH "NAME"
\fBknife\-cookbook\-site\fR \- Install and update open source cookbooks
.
.SH "SYNOPSIS"
\fBknife\fR \fBcookbook site\fR \fIsub\-command\fR \fI(options)\fR
.
.SH "COOKBOOK SITE SUB\-COMMANDS"
\fBknife cookbook site\fR provides the following subcommands:
.
.SH "INSTALL"
\fBcookbook site install COOKBOOK [VERSION]\fR \fI(options)\fR
.
.TP
\fB\-D\fR, \fB\-\-skip\-dependencies\fR
Skip automatic installation of dependencies\.
.
.TP
\fB\-o\fR, \fB\-\-cookbook\-path PATH\fR
Install cookbooks to PATH
.
.TP
\fB\-B\fR, \fB\-\-branch BRANCH\fR
Default branch to work with [defaults to master]
.
.P
Uses git(1) version control in conjunction with the cookbook site to install community contributed cookbooks to your local cookbook repository\. Running \fBknife cookbook site install\fR does the following:
.
.IP "1." 4
A new "pristine copy" branch is created in git for tracking the upstream;
.
.IP "2." 4
All existing cookbooks are removed from the branch;
.
.IP "3." 4
The cookbook is downloaded from the cookbook site in tarball form;
.
.IP "4." 4
The downloaded cookbook is untarred, and its contents commited via git;
.
.IP "5." 4
The pristine copy branch is merged into the master branch\.
.
.IP "" 0
.
.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
Unless \fI\-\-skip\-dependencies\fR is specified, the process is applied recursively to all the cookbooks \fICOOKBOOK\fR depends on (via metadata \fIdependencies\fR)\.
.
.SH "DOWNLOAD"
\fBknife cookbook site download COOKBOOK [VERSION]\fR \fI(options)\fR
.
.TP
\fB\-f\fR, \fB\-\-file FILE\fR
The filename to write to
.
.TP
\fB\-\-force\fR
Force download deprecated cookbook
.
.P
Downloads a specific cookbook from the Community site, optionally specifying a certain version\.
.
.SH "LIST"
\fBknife cookbook site list\fR \fI(options)\fR
.
.TP
\fB\-w\fR, \fB\-\-with\-uri\fR
Show corresponding URIs
.
.P
Lists available cookbooks from the Community site\.
.
.SH "SEARCH"
\fBknife cookbook site search QUERY\fR \fI(options)\fR
.
.P
Searches for available cookbooks matching the specified query\.
.
.SH "SHARE"
\fBknife cookbook site share COOKBOOK CATEGORY\fR \fI(options)\fR
.
.TP
\fB\-k\fR, \fB\-\-key KEY\fR
API Client Key
.
.TP
\fB\-u\fR, \fB\-\-user USER\fR
API Client Username
.
.TP
\fB\-o\fR, \fB\-\-cookbook\-path PATH:PATH\fR
A colon\-separated path to look for cookbooks in
.
.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\.
.
.SH "UNSHARE"
\fBknife cookbook site unshare COOKBOOK\fR
.
.P
Stops sharing the specified cookbook on the Opscode cookbooks site\.
.
.SH "SHOW"
\fBknife cookbook site show COOKBOOK [VERSION]\fR \fI(options)\fR
.
.P
Shows information from the site about a particular cookbook\.
.
.SH "DESCRIPTION"
The cookbook site, \fIhttp://community\.opscode\.com/\fR, 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
\fBknife cookbook site\fR 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 \fBknife cookbook site share\fR command, you must create an account on the cookbook site and configure your credentials via command line option or in your knife configuration file\.
.
.SH "EXAMPLES"
Uploading cookbooks to the Opscode cookbooks site:
.
.IP "" 4
.
.nf
knife cookbook site share example Other \-k ~/\.chef/USERNAME\.pem \-u USERNAME
.
.fi
.
.IP "" 0
.
.SH "SEE ALSO"
\fBknife\-cookbook(1)\fR \fIhttp://community\.opscode\.com/cookbooks\fR
.
.SH "AUTHOR"
Chef was written by Adam Jacob \fIadam@opscode\.com\fR with many contributions from the community\.
.
.SH "DOCUMENTATION"
This manual page was written by Joshua Timberman \fIjoshua@opscode\.com\fR\. Permission is granted to copy, distribute and / or modify this document under the terms of the Apache 2\.0 License\.
.
.SH "CHEF"
Knife is distributed with Chef\. \fIhttp://wiki\.opscode\.com/display/chef/Home\fR
|
