path: root/distro/common/man/man1/knife-download.1

.\" Man page generated from reStructuredText.
.
.TH "KNIFE-DOWNLOAD" "1" "Chef 12.0" "" "knife download"
.SH NAME
knife-download \- The man page for the knife download subcommand.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
The \fBknife download\fP subcommand is used to download roles, cookbooks, environments, nodes, and data bags from the Chef server to the current working directory. It can be used to back up data on the Chef server, inspect the state of one or more files, or to extract out\-of\-process changes users may have made to files on the Chef server, such as if a user made a change that bypassed version source control. This subcommand is often used in conjunction with \fBknife diff\fP, which can be used to see exactly what changes will be downloaded, and then \fBknife upload\fP, which does the opposite of \fBknife download\fP\&.
.sp
\fBSyntax\fP
.sp
This subcommand has the following syntax:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download [PATTERN...] (options)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBOptions\fP
.sp
This subcommand has the following options:
.INDENT 0.0
.TP
.B \fB\-c CONFIG_FILE\fP, \fB\-\-config CONFIG_FILE\fP
The configuration file to use.
.TP
.B \fB\-\-chef\-repo\-path PATH\fP
The path to the chef\-repo\&. This setting will override the default path to the chef\-repo\&. Default: same as specified by \fBchef_repo_path\fP in config.rb.
.TP
.B \fB\-\-chef\-zero\-port PORT\fP
The port on which chef\-zero will listen.
.TP
.B \fB\-\-[no\-]color\fP
Use to view colored output.
.TP
.B \fB\-\-concurrency\fP
The number of allowed concurrent connections. Default: \fB10\fP\&.
.TP
.B \fB\-\-cookbook\-version VERSION\fP
The version of a cookbook to be downloaded.
.TP
.B \fB\-d\fP, \fB\-\-disable\-editing\fP
Use to prevent the $EDITOR from being opened and to accept data as\-is.
.TP
.B \fB\-\-defaults\fP
Use to have knife use the default value instead of asking a user to provide one.
.TP
.B \fB\-\-[no\-]diff\fP
Use to download only new and modified files. Set to \fBfalse\fP to download all files. Default: \fB\-\-diff\fP\&.
.TP
.B \fB\-e EDITOR\fP, \fB\-\-editor EDITOR\fP
The $EDITOR that is used for all interactive commands.
.TP
.B \fB\-E ENVIRONMENT\fP, \fB\-\-environment ENVIRONMENT\fP
The name of the environment. When this option is added to a command, the command will run only against the named environment.
.TP
.B \fB\-F FORMAT\fP, \fB\-\-format FORMAT\fP
The output format: \fBsummary\fP (default), \fBtext\fP, \fBjson\fP, \fByaml\fP, and \fBpp\fP\&.
.TP
.B \fB\-\-[no\-]force\fP
Use \fB\-\-force\fP to download files even when the file on the hard drive is identical to the object on the server (role, cookbook, etc.). By default, files are compared to see if they have equivalent content, and local files are only overwritten if they are different. Default: \fB\-\-no\-force\fP\&.
.TP
.B \fB\-h\fP, \fB\-\-help\fP
Shows help for the command.
.TP
.B \fB\-k KEY\fP, \fB\-\-key KEY\fP
The private key that knife will use to sign requests made by the API client to the Chef server\&.
.TP
.B \fB\-n\fP, \fB\-\-dry\-run\fP
Use to take no action and only print out results. Default: \fBfalse\fP\&.
.TP
.B \fB\-\-print\-after\fP
Use to show data after a destructive operation.
.TP
.B \fB\-\-[no\-]purge\fP
Use \fB\-\-purge\fP to delete local files and directories that do not exist on the Chef server\&. By default, if a role, cookbook, etc. does not exist on the Chef server, the local file for said role will be left alone and NOT deleted. Default: \fB\-\-no\-purge\fP\&.
.TP
.B \fB\-\-[no\-]recurse\fP
Use \fB\-\-no\-recurse\fP to disable downloading a directory recursively. Default: \fB\-\-recurse\fP\&.
.TP
.B \fB\-\-repo\-mode MODE\fP
The layout of the local chef\-repo\&. Possible values: \fBstatic\fP, \fBeverything\fP, or \fBhosted_everything\fP\&. Use \fBstatic\fP for just roles, environments, cookbooks, and data bags. By default, \fBeverything\fP and \fBhosted_everything\fP are dynamically selected depending on the server type. Default: \fBeverything\fP / \fBhosted_everything\fP\&.
.TP
.B \fB\-s URL\fP, \fB\-\-server\-url URL\fP
The URL for the Chef server\&.
.TP
.B \fB\-u USER\fP, \fB\-\-user USER\fP
The user name used by knife to sign requests made by the API client to the Chef server\&. Authentication will fail if the user name does not match the private key.
.TP
.B \fB\-v\fP, \fB\-\-version\fP
The version of the chef\-client\&.
.TP
.B \fB\-V\fP, \fB\-\-verbose\fP
Set for more verbose outputs. Use \fB\-VV\fP for maximum verbosity.
.TP
.B \fB\-y\fP, \fB\-\-yes\fP
Use to respond to all confirmation prompts with "Yes". knife will not ask for confirmation.
.TP
.B \fB\-z\fP, \fB\-\-local\-mode\fP
Use to run the chef\-client in local mode. This allows all commands that work against the Chef server to also work against the local chef\-repo\&.
.UNINDENT
.sp
\fBExamples\fP
.sp
To download the entire chef\-repo from the Chef server, browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download /
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To download the \fBcookbooks/\fP directory from the Chef server, browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download cookbooks
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from anywhere in the chef\-repo, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download /cookbooks
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To download the \fBenvironments/\fP directory from the Chef server, browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download environments
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from anywhere in the chef\-repo, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download /environments
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To download an environment named "production" from the Chef server, browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download environments/production.json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from the \fBenvironments/\fP directory, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download production.json
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To download the \fBroles/\fP directory from the Chef server, browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download roles
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
or from anywhere in the chef\-repo, enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ knife download /roles
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
To download all cookbooks that start with "apache" and belong to the "webserver" role, browse to the top level of the chef\-repo and enter:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$  knife download cookbooks/apache\e* roles/webserver.json
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
Chef
.\" Generated by docutils manpage writer.
.