chef-dk 2.4.17 → 2.5.3

data/LICENSE

@@ -1,201 +1,201 @@
-                              Apache License
-                        Version 2.0, January 2004
-                     http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-   "License" shall mean the terms and conditions for use, reproduction,
-   and distribution as defined by Sections 1 through 9 of this document.
-
-   "Licensor" shall mean the copyright owner or entity authorized by
-   the copyright owner that is granting the License.
-
-   "Legal Entity" shall mean the union of the acting entity and all
-   other entities that control, are controlled by, or are under common
-   control with that entity. For the purposes of this definition,
-   "control" means (i) the power, direct or indirect, to cause the
-   direction or management of such entity, whether by contract or
-   otherwise, or (ii) ownership of fifty percent (50%) or more of the
-   outstanding shares, or (iii) beneficial ownership of such entity.
-
-   "You" (or "Your") shall mean an individual or Legal Entity
-   exercising permissions granted by this License.
-
-   "Source" form shall mean the preferred form for making modifications,
-   including but not limited to software source code, documentation
-   source, and configuration files.
-
-   "Object" form shall mean any form resulting from mechanical
-   transformation or translation of a Source form, including but
-   not limited to compiled object code, generated documentation,
-   and conversions to other media types.
-
-   "Work" shall mean the work of authorship, whether in Source or
-   Object form, made available under the License, as indicated by a
-   copyright notice that is included in or attached to the work
-   (an example is provided in the Appendix below).
-
-   "Derivative Works" shall mean any work, whether in Source or Object
-   form, that is based on (or derived from) the Work and for which the
-   editorial revisions, annotations, elaborations, or other modifications
-   represent, as a whole, an original work of authorship. For the purposes
-   of this License, Derivative Works shall not include works that remain
-   separable from, or merely link (or bind by name) to the interfaces of,
-   the Work and Derivative Works thereof.
-
-   "Contribution" shall mean any work of authorship, including
-   the original version of the Work and any modifications or additions
-   to that Work or Derivative Works thereof, that is intentionally
-   submitted to Licensor for inclusion in the Work by the copyright owner
-   or by an individual or Legal Entity authorized to submit on behalf of
-   the copyright owner. For the purposes of this definition, "submitted"
-   means any form of electronic, verbal, or written communication sent
-   to the Licensor or its representatives, including but not limited to
-   communication on electronic mailing lists, source code control systems,
-   and issue tracking systems that are managed by, or on behalf of, the
-   Licensor for the purpose of discussing and improving the Work, but
-   excluding communication that is conspicuously marked or otherwise
-   designated in writing by the copyright owner as "Not a Contribution."
-
-   "Contributor" shall mean Licensor and any individual or Legal Entity
-   on behalf of whom a Contribution has been received by Licensor and
-   subsequently incorporated within the Work.
-
-2. Grant of Copyright License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   copyright license to reproduce, prepare Derivative Works of,
-   publicly display, publicly perform, sublicense, and distribute the
-   Work and such Derivative Works in Source or Object form.
-
-3. Grant of Patent License. Subject to the terms and conditions of
-   this License, each Contributor hereby grants to You a perpetual,
-   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-   (except as stated in this section) patent license to make, have made,
-   use, offer to sell, sell, import, and otherwise transfer the Work,
-   where such license applies only to those patent claims licensable
-   by such Contributor that are necessarily infringed by their
-   Contribution(s) alone or by combination of their Contribution(s)
-   with the Work to which such Contribution(s) was submitted. If You
-   institute patent litigation against any entity (including a
-   cross-claim or counterclaim in a lawsuit) alleging that the Work
-   or a Contribution incorporated within the Work constitutes direct
-   or contributory patent infringement, then any patent licenses
-   granted to You under this License for that Work shall terminate
-   as of the date such litigation is filed.
-
-4. Redistribution. You may reproduce and distribute copies of the
-   Work or Derivative Works thereof in any medium, with or without
-   modifications, and in Source or Object form, provided that You
-   meet the following conditions:
-
-   (a) You must give any other recipients of the Work or
-       Derivative Works a copy of this License; and
-
-   (b) You must cause any modified files to carry prominent notices
-       stating that You changed the files; and
-
-   (c) You must retain, in the Source form of any Derivative Works
-       that You distribute, all copyright, patent, trademark, and
-       attribution notices from the Source form of the Work,
-       excluding those notices that do not pertain to any part of
-       the Derivative Works; and
-
-   (d) If the Work includes a "NOTICE" text file as part of its
-       distribution, then any Derivative Works that You distribute must
-       include a readable copy of the attribution notices contained
-       within such NOTICE file, excluding those notices that do not
-       pertain to any part of the Derivative Works, in at least one
-       of the following places: within a NOTICE text file distributed
-       as part of the Derivative Works; within the Source form or
-       documentation, if provided along with the Derivative Works; or,
-       within a display generated by the Derivative Works, if and
-       wherever such third-party notices normally appear. The contents
-       of the NOTICE file are for informational purposes only and
-       do not modify the License. You may add Your own attribution
-       notices within Derivative Works that You distribute, alongside
-       or as an addendum to the NOTICE text from the Work, provided
-       that such additional attribution notices cannot be construed
-       as modifying the License.
-
-   You may add Your own copyright statement to Your modifications and
-   may provide additional or different license terms and conditions
-   for use, reproduction, or distribution of Your modifications, or
-   for any such Derivative Works as a whole, provided Your use,
-   reproduction, and distribution of the Work otherwise complies with
-   the conditions stated in this License.
-
-5. Submission of Contributions. Unless You explicitly state otherwise,
-   any Contribution intentionally submitted for inclusion in the Work
-   by You to the Licensor shall be under the terms and conditions of
-   this License, without any additional terms or conditions.
-   Notwithstanding the above, nothing herein shall supersede or modify
-   the terms of any separate license agreement you may have executed
-   with Licensor regarding such Contributions.
-
-6. Trademarks. This License does not grant permission to use the trade
-   names, trademarks, service marks, or product names of the Licensor,
-   except as required for reasonable and customary use in describing the
-   origin of the Work and reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty. Unless required by applicable law or
-   agreed to in writing, Licensor provides the Work (and each
-   Contributor provides its Contributions) on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-   implied, including, without limitation, any warranties or conditions
-   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-   PARTICULAR PURPOSE. You are solely responsible for determining the
-   appropriateness of using or redistributing the Work and assume any
-   risks associated with Your exercise of permissions under this License.
-
-8. Limitation of Liability. In no event and under no legal theory,
-   whether in tort (including negligence), contract, or otherwise,
-   unless required by applicable law (such as deliberate and grossly
-   negligent acts) or agreed to in writing, shall any Contributor be
-   liable to You for damages, including any direct, indirect, special,
-   incidental, or consequential damages of any character arising as a
-   result of this License or out of the use or inability to use the
-   Work (including but not limited to damages for loss of goodwill,
-   work stoppage, computer failure or malfunction, or any and all
-   other commercial damages or losses), even if such Contributor
-   has been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability. While redistributing
-   the Work or Derivative Works thereof, You may choose to offer,
-   and charge a fee for, acceptance of support, warranty, indemnity,
-   or other liability obligations and/or rights consistent with this
-   License. However, in accepting such obligations, You may act only
-   on Your own behalf and on Your sole responsibility, not on behalf
-   of any other Contributor, and only if You agree to indemnify,
-   defend, and hold each Contributor harmless for any liability
-   incurred by, or claims asserted against, such Contributor by reason
-   of your accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work.
-
-   To apply the Apache License to your work, attach the following
-   boilerplate notice, with the fields enclosed by brackets "[]"
-   replaced with your own identifying information. (Don't include
-   the brackets!)  The text should be enclosed in the appropriate
-   comment syntax for the file format. We also recommend that a
-   file or class name and description of purpose be included on the
-   same "printed page" as the copyright notice for easier
-   identification within third-party archives.
-
-Copyright [yyyy] [name of copyright owner]
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,333 +1,333 @@
-# Chef Development Kit
-
-[![Build Status Master](https://travis-ci.org/chef/chef-dk.svg?branch=master)](https://travis-ci.org/chef/chef-dk)
-[![Build Status Master](https://ci.appveyor.com/api/projects/status/github/chef/chef-dk?branch=master&svg=true&passingText=master%20-%20Ok&pendingText=master%20-%20Pending&failingText=master%20-%20Failing)](https://ci.appveyor.com/project/Chef/chef-dk/branch/master)
-[![](https://img.shields.io/badge/Release%20Policy-Cadence%20Release-brightgreen.svg)](https://github.com/chef/chef-rfc/blob/master/rfc086-chef-oss-project-policies.md#cadence-release)
-
-Chef Development Kit (ChefDK) brings Chef and the development tools developed by the Chef Community together and acts as the consistent interface to this awesomeness. This awesomeness is composed of:
-
-* [Chef][]
-* [Berkshelf][]
-* [Test Kitchen][]
-* [ChefSpec][]
-* [Foodcritic][]
-* [Cookstyle][]
-* [Delivery CLI][]
-* [Push Jobs Client][]
-
-This repository contains the code for the `chef` command. The full
-package is built with omnibus. Project and component build definitions
-are in the omnibus directory in this repository.
-
-## Installation
-
-You can get the [latest release of ChefDK from the downloads page][ChefDK].
-
-On Mac OS X, you can also use [homebrew-cask](https://caskroom.github.io/)
-to `brew cask install chefdk`.
-
-Once you install the package, the `chef-client` suite, `berks`,
-`kitchen`, and this application (`chef`) will be symlinked into your
-system bin directory, ready to use.
-
-### Pre-release Candidates
-
-The following commands will download the latest ChefDK package from the `current` channel.  The `current` channel holds builds that have passed testing and are candidates for release.
-More information about flags supported by install.sh available here: https://docs.chef.io/api_omnitruck.html
-
-#### Linux and OS/X:
-
-In a terminal, run:
-
-`curl https://omnitruck.chef.io/install.sh | sudo bash -s -- -c current -P chefdk`
-
-To download a specific version, append the `-v` flag.  EG, `-v 0.9.0`.
-
-#### Windows
-
-Open up a Powershell command prompt as Administrator and run:
-
-`. { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install -channel current -project chefdk`
-
-To download a specific version, append the `-version` flag.  EG, `-version 0.9.0`.
-
-## Usage
-
-For help with [Berkshelf][], [Test Kitchen][], [ChefSpec][], [Foodcritic][], [Delivery CLI][] or [Push Jobs Client][],
-visit those projects' homepages for documentation and guides. For help with
-`chef-client` and `knife`, visit the [Chef documentation][]
-and [Learn Chef][].
-
-### The `chef` Command
-
-Our goal is for `chef` to become a workflow tool that builds on the
-ideas of Berkshelf to provide an awesome experience that encourages
-quick iteration and testing (and makes those things easy) and provides a
-way to easily, reliably, and repeatably roll out new automation code to
-your infrastructure.
-
-While we've got a long way to go before we reach that goal we do have
-some helpful bits of functionality already included in the `chef`
-command:
-
-#### `chef generate`
-The generate subcommand generates skeleton Chef code
-layouts so you can skip repetitive boilerplate and get down to
-automating your infrastructure quickly. Unlike other generators, it only
-generates the minimum required files when creating a cookbook so you can
-focus on the task at hand without getting overwhelmed by stuff you don't
-need.
-
-The following generators are built-in:
-
-* `chef generate app` Creates an "application" layout that supports
-multiple cookbooks. This is a somewhat experimental compromise between
-the one-repo-per-cookbook and monolithic-chef-repo styles of cookbook
-management.
-
-* `chef generate cookbook` Creates a single cookbook.
-* `chef generate recipe` Creates a new recipe file in an existing
-cookbook.
-* `chef generate attribute` Creates a new attributes file in an existing
-cookbook.
-* `chef generate template` Creates a new template file in an existing
-cookbook. Use the `-s SOURCE` option to copy a source file's content to
-populate the template.
-* `chef generate file` Creates a new cookbook file in an existing
-cookbook. Supports the `-s SOURCE` option similar to template.
-* `chef generate lwrp` Creates a new LWRP resource and provider in an
-existing cookbook.
-
-The `chef generate` command also accepts additional `--generator-arg key=value`
-pairs that can be used to supply ad-hoc data to a generator cookbook.
-For example, you might specify `--generator-arg database=mysql` and then only
-write a template for `recipes/mysql.rb` if `context.database == 'mysql'`.
-
-#### `chef gem`
-`chef gem` is a wrapper command that manages installation and updating
-of rubygems for the Ruby installation embedded in the ChefDK package.
-This allows you to install knife plugins, Test Kitchen drivers, and
-other Ruby applications that are not packaged with ChefDK.
-
-Gems are installed to a `.chefdk` directory in your home directory; any
-executables included with a gem you install will be created in
-`~/.chefdk/gem/ruby/2.1.0/bin`. You can run these executables with
-`chef exec`, or use `chef shell-init` to add ChefDK's paths to your
-environment. Those commands are documented below.
-
-### `chef exec`
-`chef exec <command>` runs any arbitrary shell command with the PATH
-environment variable and the ruby environment variables (`GEM_HOME`,
-`GEM_PATH`, etc.) setup to point at the embedded ChefDK omnibus environment.
-
-### `chef shell-init`
-`chef shell-init SHELL_NAME` emits shell commands that modify your
-environment to make ChefDK your primary ruby. It supports bash, zsh,
-fish and PowerShell (posh). For more information to help you decide if
-this is desirable and instructions, see "Using ChefDK as Your Primary
-Development Environment" below.
-
-### `chef install`
-`chef install` reads a `Policyfile.rb` document, which contains a
-`run_list` and optional cookbook version constraints, finds a set of
-cookbooks that provide the desired recipes and meet dependency
-constraints, and emits a `Policyfile.lock.json` describing the expanded
-run list and locked cookbook set. The `Policyfile.lock.json` can be used
-to install the cookbooks on another machine. The policy lock can be
-uploaded to a Chef Server (via the `chef push` command) to apply the
-expanded run list and locked cookbook set to nodes in your
-infrastructure. See the POLICYFILE_README.md for further details.
-
-### `chef push`
-`chef push POLICY_GROUP` uploads a Policyfile.lock.json along with the cookbooks it
-references to a Chef Server. The policy lock is applied to a
-`POLICY_GROUP`, which is a set of nodes that share the same run list and
-cookbook set. This command operates in compatibility mode and has the
-same caveats as `chef install`. See the POLICYFILE_README.md for further
-details.
-
-### `chef update`
-`chef update` updates a Policyfile.lock.json with the latest cookbooks
-from upstream sources. It supports an `--attributes` flag which will
-cause only attributes from the Policyfile.rb to be updated.
-
-### `chef diff`
-`chef diff` shows an itemized diff between Policyfile locks. It can
-compare Policyfile locks from local disk, git, and/or the Chef Server,
-based on the options given.
-
-#### `chef verify`
-`chef verify` tests the embedded applications. By default it runs a
-quick "smoke test" to verify that the embedded applications are
-installed correctly and can run basic commands. As an end user this is
-probably all you'll ever need, but `verify` can also optionally run unit
-and integration tests by supplying the `--unit` and `--integration`
-flags, respectively.
-
-You can also focus on a specific suite of tests by passing it as an argument.
-For example `chef verify git` will only run the smoke tests for the `git` suite.
-
-*WARNING:* The integration tests will do dangerous things like start
-HTTP servers with access to your filesystem and even create users and
-groups if run with sufficient privileges. The tests may also be
-sensitive to your machine's configuration. If you choose to run these,
-we recommend to only run them on dedicated, isolated hosts (we do this
-in our build cluster to verify each build).
-
-### Using ChefDK as Your Primary Development Environment
-
-By default, ChefDK only adds a few select applications to your `PATH`
-and packages them in such a way that they are isolated from any other
-Ruby development tools you have on your system. If you're happily using
-your system ruby, rvm, rbenv, chruby or any other development
-environment, you can continue to do so. Just ensure that the ChefDK
-provided applications appear first in your `PATH` before any
-gem-installed versions and you're good to go.
-
-If you'd like to use ChefDK as your primary Ruby/Chef development
-environment, however, you can do so by initializing your shell with
-ChefDK's environment.
-
-To try it temporarily, in a new terminal session, run:
-
-```sh
-eval "$(chef shell-init SHELL_NAME)"
-```
-
-where `SHELL_NAME` is the name of your shell (usually bash, but zsh is
-also common). This modifies your `PATH` and `GEM_*` environment
-variables to include ChefDK's paths (run without the `eval` to see the
-generated code). Now your default `ruby` and associated tools will be
-the ones from ChefDK:
-
-```sh
-which ruby
-# => /opt/chefdk/embedded/bin/ruby
-```
-
-To add ChefDK to your shell's environment permanently, add the
-initialization step to your shell's profile:
-
-```sh
-echo 'eval "$(chef shell-init SHELL_NAME)"' >> ~/.YOUR_SHELL_PROFILE
-```
-
-Where `YOUR_SHELL_PROFILE` is `~/.bash_profile` for most bash users,
-`~/.zshrc` for zsh, and `~/.bashrc` on Ubuntu.
-
-#### Powershell
-
-You can use `chef shell-init` with PowerShell on Windows.
-
-To try it in your current session:
-
-```posh
-chef shell-init powershell | Invoke-Expression
-```
-
-To enable it permanently:
-
-```posh
-"chef shell-init powershell | Invoke-Expression" >> $PROFILE
-```
-
-#### Fish
-
-`chef shell-init` also supports fish.
-
-To try it:
-
-```fish
-eval (chef shell-init fish)
-```
-
-To permanently enable:
-
-```fish
-echo 'eval (chef shell-init SHELL_NAME)' >> ~/.config/fish/config.fish
-```
-
-## Uninstallation Instructions
-
-### Mac OS X
-
-You can uninstall Chef Development Kit on Mac using the below commands.
-
-First, remove the main package files:
-
-```sh
-# Remove the installed files
-sudo rm -rf /opt/chefdk
-
-# Remove the system installation entry
-sudo pkgutil --forget com.getchef.pkg.chefdk
-```
-
-Next, remove the symlinks which the Chef Development Kit installs. The
-location for these differs based on your OS X version.
-
-Pre-El Capitan:
-
-```sh
-# Symlinks are in /usr/bin
-ls -la /usr/bin | egrep '/opt/chefdk' | awk '{ print $9 }' | sudo xargs -I % rm -f /usr/bin/%
-```
-
-Post-El Capitan:
-
-```sh
-# Symlinks are in /usr/local/bin
-ls -la /usr/local/bin | egrep '/opt/chefdk' | awk '{ print $9 }' | sudo xargs -I % rm -f /usr/local/bin/%
-```
-
-### Windows
-
-You can use `Add / Remove Programs` on Windows to remove the Chef Development
-Kit from your system.
-
-### RHEL
-
-You can use `rpm` to uninstall Chef Development Kit on RHEL based systems:
-
-```sh
-rpm -qa *chefdk*
-yum remove <package>
-rm -rf /opt/chefdk
-rm -rf ~/.chefdk
-```
-
-### Ubuntu
-
-You can use `dpkg` to uninstall Chef Development Kit on Ubuntu based systems:
-
-```sh
-dpkg --list | grep chefdk # or dpkg --status chefdk
-
-# Purge chefdk from the system.
-# see man dkpg for details
-dpkg -P chefdk
-```
-
-## Contributing
-
-For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
-
-# For ChefDK Developers
-
-See the [Development Guide](CONTRIBUTING.md) for how to get started with
-development on the ChefDK itself, as well as details on how dependencies,
-packaging, and building works.
-
-- - -
-
-[Berkshelf]: https://docs.chef.io/berkshelf.html "Berkshelf"
-[Chef]: https://www.chef.io/chef/ "Chef"
-[ChefDK]: https://downloads.chef.io/chefdk "Chef Development Kit"
-[Chef Documentation]: https://docs.chef.io "Chef Documentation"
-[ChefSpec]: http://chefspec.github.io/chefspec/ "ChefSpec"
-[Cookstyle]: https://docs.chef.io/cookstyle.html "Cookstyle"
-[Foodcritic]: http://foodcritic.io "Foodcritic"
-[Learn Chef]: https://learn.chef.io "Learn Chef"
-[Test Kitchen]: http://kitchen.ci "Test Kitchen"
-[Delivery CLI]: https://docs.chef.io/delivery_cli.html "Delivery CLI"
-[Push Jobs Client]: https://docs.chef.io/push_jobs.html#push-jobs-client "Push Jobs Client"
+# Chef Development Kit
+
+[![Build Status Master](https://travis-ci.org/chef/chef-dk.svg?branch=master)](https://travis-ci.org/chef/chef-dk)
+[![Build Status Master](https://ci.appveyor.com/api/projects/status/github/chef/chef-dk?branch=master&svg=true&passingText=master%20-%20Ok&pendingText=master%20-%20Pending&failingText=master%20-%20Failing)](https://ci.appveyor.com/project/Chef/chef-dk/branch/master)
+[![](https://img.shields.io/badge/Release%20Policy-Cadence%20Release-brightgreen.svg)](https://github.com/chef/chef-rfc/blob/master/rfc086-chef-oss-project-policies.md#cadence-release)
+
+Chef Development Kit (ChefDK) brings Chef and the development tools developed by the Chef Community together and acts as the consistent interface to this awesomeness. This awesomeness is composed of:
+
+* [Chef][]
+* [Berkshelf][]
+* [Test Kitchen][]
+* [ChefSpec][]
+* [Foodcritic][]
+* [Cookstyle][]
+* [Delivery CLI][]
+* [Push Jobs Client][]
+
+This repository contains the code for the `chef` command. The full
+package is built with omnibus. Project and component build definitions
+are in the omnibus directory in this repository.
+
+## Installation
+
+You can get the [latest release of ChefDK from the downloads page][ChefDK].
+
+On Mac OS X, you can also use [homebrew-cask](https://caskroom.github.io/)
+to `brew cask install chefdk`.
+
+Once you install the package, the `chef-client` suite, `berks`,
+`kitchen`, and this application (`chef`) will be symlinked into your
+system bin directory, ready to use.
+
+### Pre-release Candidates
+
+The following commands will download the latest ChefDK package from the `current` channel.  The `current` channel holds builds that have passed testing and are candidates for release.
+More information about flags supported by install.sh available here: https://docs.chef.io/api_omnitruck.html
+
+#### Linux and OS/X:
+
+In a terminal, run:
+
+`curl https://omnitruck.chef.io/install.sh | sudo bash -s -- -c current -P chefdk`
+
+To download a specific version, append the `-v` flag.  EG, `-v 0.9.0`.
+
+#### Windows
+
+Open up a Powershell command prompt as Administrator and run:
+
+`. { iwr -useb https://omnitruck.chef.io/install.ps1 } | iex; install -channel current -project chefdk`
+
+To download a specific version, append the `-version` flag.  EG, `-version 0.9.0`.
+
+## Usage
+
+For help with [Berkshelf][], [Test Kitchen][], [ChefSpec][], [Foodcritic][], [Delivery CLI][] or [Push Jobs Client][],
+visit those projects' homepages for documentation and guides. For help with
+`chef-client` and `knife`, visit the [Chef documentation][]
+and [Learn Chef][].
+
+### The `chef` Command
+
+Our goal is for `chef` to become a workflow tool that builds on the
+ideas of Berkshelf to provide an awesome experience that encourages
+quick iteration and testing (and makes those things easy) and provides a
+way to easily, reliably, and repeatably roll out new automation code to
+your infrastructure.
+
+While we've got a long way to go before we reach that goal we do have
+some helpful bits of functionality already included in the `chef`
+command:
+
+#### `chef generate`
+The generate subcommand generates skeleton Chef code
+layouts so you can skip repetitive boilerplate and get down to
+automating your infrastructure quickly. Unlike other generators, it only
+generates the minimum required files when creating a cookbook so you can
+focus on the task at hand without getting overwhelmed by stuff you don't
+need.
+
+The following generators are built-in:
+
+* `chef generate app` Creates an "application" layout that supports
+multiple cookbooks. This is a somewhat experimental compromise between
+the one-repo-per-cookbook and monolithic-chef-repo styles of cookbook
+management.
+
+* `chef generate cookbook` Creates a single cookbook.
+* `chef generate recipe` Creates a new recipe file in an existing
+cookbook.
+* `chef generate attribute` Creates a new attributes file in an existing
+cookbook.
+* `chef generate template` Creates a new template file in an existing
+cookbook. Use the `-s SOURCE` option to copy a source file's content to
+populate the template.
+* `chef generate file` Creates a new cookbook file in an existing
+cookbook. Supports the `-s SOURCE` option similar to template.
+* `chef generate lwrp` Creates a new LWRP resource and provider in an
+existing cookbook.
+
+The `chef generate` command also accepts additional `--generator-arg key=value`
+pairs that can be used to supply ad-hoc data to a generator cookbook.
+For example, you might specify `--generator-arg database=mysql` and then only
+write a template for `recipes/mysql.rb` if `context.database == 'mysql'`.
+
+#### `chef gem`
+`chef gem` is a wrapper command that manages installation and updating
+of rubygems for the Ruby installation embedded in the ChefDK package.
+This allows you to install knife plugins, Test Kitchen drivers, and
+other Ruby applications that are not packaged with ChefDK.
+
+Gems are installed to a `.chefdk` directory in your home directory; any
+executables included with a gem you install will be created in
+`~/.chefdk/gem/ruby/2.1.0/bin`. You can run these executables with
+`chef exec`, or use `chef shell-init` to add ChefDK's paths to your
+environment. Those commands are documented below.
+
+### `chef exec`
+`chef exec <command>` runs any arbitrary shell command with the PATH
+environment variable and the ruby environment variables (`GEM_HOME`,
+`GEM_PATH`, etc.) setup to point at the embedded ChefDK omnibus environment.
+
+### `chef shell-init`
+`chef shell-init SHELL_NAME` emits shell commands that modify your
+environment to make ChefDK your primary ruby. It supports bash, zsh,
+fish and PowerShell (posh). For more information to help you decide if
+this is desirable and instructions, see "Using ChefDK as Your Primary
+Development Environment" below.
+
+### `chef install`
+`chef install` reads a `Policyfile.rb` document, which contains a
+`run_list` and optional cookbook version constraints, finds a set of
+cookbooks that provide the desired recipes and meet dependency
+constraints, and emits a `Policyfile.lock.json` describing the expanded
+run list and locked cookbook set. The `Policyfile.lock.json` can be used
+to install the cookbooks on another machine. The policy lock can be
+uploaded to a Chef Server (via the `chef push` command) to apply the
+expanded run list and locked cookbook set to nodes in your
+infrastructure. See the POLICYFILE_README.md for further details.
+
+### `chef push`
+`chef push POLICY_GROUP` uploads a Policyfile.lock.json along with the cookbooks it
+references to a Chef Server. The policy lock is applied to a
+`POLICY_GROUP`, which is a set of nodes that share the same run list and
+cookbook set. This command operates in compatibility mode and has the
+same caveats as `chef install`. See the POLICYFILE_README.md for further
+details.
+
+### `chef update`
+`chef update` updates a Policyfile.lock.json with the latest cookbooks
+from upstream sources. It supports an `--attributes` flag which will
+cause only attributes from the Policyfile.rb to be updated.
+
+### `chef diff`
+`chef diff` shows an itemized diff between Policyfile locks. It can
+compare Policyfile locks from local disk, git, and/or the Chef Server,
+based on the options given.
+
+#### `chef verify`
+`chef verify` tests the embedded applications. By default it runs a
+quick "smoke test" to verify that the embedded applications are
+installed correctly and can run basic commands. As an end user this is
+probably all you'll ever need, but `verify` can also optionally run unit
+and integration tests by supplying the `--unit` and `--integration`
+flags, respectively.
+
+You can also focus on a specific suite of tests by passing it as an argument.
+For example `chef verify git` will only run the smoke tests for the `git` suite.
+
+*WARNING:* The integration tests will do dangerous things like start
+HTTP servers with access to your filesystem and even create users and
+groups if run with sufficient privileges. The tests may also be
+sensitive to your machine's configuration. If you choose to run these,
+we recommend to only run them on dedicated, isolated hosts (we do this
+in our build cluster to verify each build).
+
+### Using ChefDK as Your Primary Development Environment
+
+By default, ChefDK only adds a few select applications to your `PATH`
+and packages them in such a way that they are isolated from any other
+Ruby development tools you have on your system. If you're happily using
+your system ruby, rvm, rbenv, chruby or any other development
+environment, you can continue to do so. Just ensure that the ChefDK
+provided applications appear first in your `PATH` before any
+gem-installed versions and you're good to go.
+
+If you'd like to use ChefDK as your primary Ruby/Chef development
+environment, however, you can do so by initializing your shell with
+ChefDK's environment.
+
+To try it temporarily, in a new terminal session, run:
+
+```sh
+eval "$(chef shell-init SHELL_NAME)"
+```
+
+where `SHELL_NAME` is the name of your shell (usually bash, but zsh is
+also common). This modifies your `PATH` and `GEM_*` environment
+variables to include ChefDK's paths (run without the `eval` to see the
+generated code). Now your default `ruby` and associated tools will be
+the ones from ChefDK:
+
+```sh
+which ruby
+# => /opt/chefdk/embedded/bin/ruby
+```
+
+To add ChefDK to your shell's environment permanently, add the
+initialization step to your shell's profile:
+
+```sh
+echo 'eval "$(chef shell-init SHELL_NAME)"' >> ~/.YOUR_SHELL_PROFILE
+```
+
+Where `YOUR_SHELL_PROFILE` is `~/.bash_profile` for most bash users,
+`~/.zshrc` for zsh, and `~/.bashrc` on Ubuntu.
+
+#### Powershell
+
+You can use `chef shell-init` with PowerShell on Windows.
+
+To try it in your current session:
+
+```posh
+chef shell-init powershell | Invoke-Expression
+```
+
+To enable it permanently:
+
+```posh
+"chef shell-init powershell | Invoke-Expression" >> $PROFILE
+```
+
+#### Fish
+
+`chef shell-init` also supports fish.
+
+To try it:
+
+```fish
+eval (chef shell-init fish)
+```
+
+To permanently enable:
+
+```fish
+echo 'eval (chef shell-init SHELL_NAME)' >> ~/.config/fish/config.fish
+```
+
+## Uninstallation Instructions
+
+### Mac OS X
+
+You can uninstall Chef Development Kit on Mac using the below commands.
+
+First, remove the main package files:
+
+```sh
+# Remove the installed files
+sudo rm -rf /opt/chefdk
+
+# Remove the system installation entry
+sudo pkgutil --forget com.getchef.pkg.chefdk
+```
+
+Next, remove the symlinks which the Chef Development Kit installs. The
+location for these differs based on your OS X version.
+
+Pre-El Capitan:
+
+```sh
+# Symlinks are in /usr/bin
+ls -la /usr/bin | egrep '/opt/chefdk' | awk '{ print $9 }' | sudo xargs -I % rm -f /usr/bin/%
+```
+
+Post-El Capitan:
+
+```sh
+# Symlinks are in /usr/local/bin
+ls -la /usr/local/bin | egrep '/opt/chefdk' | awk '{ print $9 }' | sudo xargs -I % rm -f /usr/local/bin/%
+```
+
+### Windows
+
+You can use `Add / Remove Programs` on Windows to remove the Chef Development
+Kit from your system.
+
+### RHEL
+
+You can use `rpm` to uninstall Chef Development Kit on RHEL based systems:
+
+```sh
+rpm -qa *chefdk*
+yum remove <package>
+rm -rf /opt/chefdk
+rm -rf ~/.chefdk
+```
+
+### Ubuntu
+
+You can use `dpkg` to uninstall Chef Development Kit on Ubuntu based systems:
+
+```sh
+dpkg --list | grep chefdk # or dpkg --status chefdk
+
+# Purge chefdk from the system.
+# see man dkpg for details
+dpkg -P chefdk
+```
+
+## Contributing
+
+For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
+
+# For ChefDK Developers
+
+See the [Development Guide](CONTRIBUTING.md) for how to get started with
+development on the ChefDK itself, as well as details on how dependencies,
+packaging, and building works.
+
+- - -
+
+[Berkshelf]: https://docs.chef.io/berkshelf.html "Berkshelf"
+[Chef]: https://www.chef.io/chef/ "Chef"
+[ChefDK]: https://downloads.chef.io/chefdk "Chef Development Kit"
+[Chef Documentation]: https://docs.chef.io "Chef Documentation"
+[ChefSpec]: http://chefspec.github.io/chefspec/ "ChefSpec"
+[Cookstyle]: https://docs.chef.io/cookstyle.html "Cookstyle"
+[Foodcritic]: http://foodcritic.io "Foodcritic"
+[Learn Chef]: https://learn.chef.io "Learn Chef"
+[Test Kitchen]: http://kitchen.ci "Test Kitchen"
+[Delivery CLI]: https://docs.chef.io/delivery_cli.html "Delivery CLI"
+[Push Jobs Client]: https://docs.chef.io/push_jobs.html#push-jobs-client "Push Jobs Client"