stow/oh-my-zsh/.oh-my-zsh/plugins/knife/README.md

   1 # knife plugin
   2
   3 This plugin adds completion for [knife](https://docs.chef.io/knife.html), a command-line tool
   4 to interact with [Chef](https://chef.io), a platform to automate and manage infrastructure via
   5 code.
   6
   7 To use it, add `knife` to the plugins array in your zshrc file:
   8 ```zsh
   9 plugins=(... knife)
  10 ```
  11
  12 ## Options
  13
  14 - `KNIFE_RELATIVE_PATH`: if set to `true`, the completion script will look for local cookbooks
  15   under the `cookbooks` folder in the chef root directory. It has preference over the other two
  16   options below. **Default:** empty.
  17
  18 - `KNIFE_COOKBOOK_PATH`: if set, it points to the folder that contains local cookbooks, for
  19    example: `/path/to/my/chef/cookbooks`. **Default:** `cookbook_path` field in `knife.rb`
  20    (see below).
  21
  22 - `KNIFE_CONF_PATH`: variable pointing to the `knife.rb` configuration file, for example
  23   `/path/to/my/.chef/knife.rb`. Only used if `$KNIFE_COOKBOOK_PATH` isn't set. If it exists,
  24   `$PWD/.chef/knife.rb` is used instead. Otherwise, if it's set, its value is used.
  25   **Default**: `$HOME/.chef/knife.rb`.