knife-spork-berks 1.3.2

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.project
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/.ruby-gemset

@@ -0,0 +1 @@
+knife-spork

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/CHANGELOG.md

@@ -0,0 +1,284 @@
+## 1.3.2 (5th Feb, 2014)
+
+Features:
+
+    - Add spork environment commands (Thanks to @jperry https://github.com/jonlives/knife-spork/pull/102)
+    - Berkshelf support for bump and check commands (Thanks to @poliva83 https://github.com/jonlives/knife-spork/pull/104)
+
+## 1.3.1 (31st Dec, 2013)
+
+Features:
+
+    - Add a cookbook_path option to spork bump (https://github.com/jonlives/knife-spork/issues/92)
+    - Add config option to promote --remote by default (https://github.com/jonlives/knife-spork/issues/95)
+
+Bugfixes:
+
+    - Fix issue with gist generation in the irccat plugin breaking when json diffs were incorrectly escaped ((https://github.com/jonlives/knife-spork/issues/97)
+    - Fix issue with data bag upload when file path is specified (https://github.com/jonlives/knife-spork/issues/98)
+
+## 1.3.0 (23rd October, 2013)
+
+Features:
+
+    - Allow a custom plugin path to be specified in config to load additional plugins from (https://github.com/jonlives/knife-spork/issues/59)
+    - Spork check will prompt for a bump if one is needed (https://github.com/jonlives/knife-spork/issues/82)
+    - Spork omni command added to perform bump, upload and promote in a single step (https://github.com/jonlives/knife-spork/issues/49)
+    - Spork role, data bag and node commands added (https://github.com/jonlives/knife-spork/issues/81)
+
+Bugfixes:
+
+    - Remove legacy code referring to "promote all cookbooks" (https://github.com/jonlives/knife-spork/issues/76)
+    - Fix incorrect cookbook version numbers in plugin output when -v used with promote (https://github.com/jonlives/knife-spork/issues/64)
+    - Replaced monkeypatched Hash#diff with an hash_diff method to fix clashes with ActiveSupport deprecation warnings. (Thanks to @RSO: https://github.com/jonlives/knife-spork/pull/84)
+    - Various fixes for Berkshelf issues (Thanks to @RSO and @sethvargo: https://github.com/jonlives/knife-spork/issues/73)
+    - Fix load_from_berkshelf method to return a CookbookVersion object (Thanks to @hanskrueger https://github.com/jonlives/knife-spork/pull/90)
+    - Fix foodcritic plugin to work properly with foodcritic > 3.0.0 (Thanks to @juliandunn https://github.com/jonlives/knife-spork/pull/94)
+
+## 1.2.2 (10th Sept, 2013)
+
+Bugfixes:
+
+    - Fix bug with promoting when environment groups are present (thanks to Jimmy Chao & Nik Keating - https://github.com/CaseCommonsDevOps)
+
+## 1.2.1 (28th June, 2013)
+
+Bugfixes:
+
+    - Fix potential error with environment_groups (thanks to Greg Karékinian - https://github.com/gkarekinian)
+
+## 1.2.0 (28th June, 2013)
+
+Features:
+
+    - StatusNet plugin (Thanks to Tomasz Napierala - https://github.com/zen)
+    - GroveIO plugin (Thanks to Greg Karékinian - https://github.com/gkarekinian)
+    - Configurable irccat message templates (Thanks to Tobias Schmidt - https://github.com/grobie)
+    - Environment Groups - Spork Promote can update multitiple environments at once by specifying the environment group name. (Thanks to Pivotal Casebook - https://github.com/pivotal-casebook)
+
+Bugfixes:
+
+    - Fix spork bump to not change quote style or whitespace (Thanks to Tobias Schmidt - https://github.com/grobie)
+    - Correct Markdown formatting error (Thanks to Jeff Blaine - https://github.com/jblaine)
+    - Fix pretty printing of environments (Thanks to Peter Schultz - https://github.com/pschultz)
+
+## 1.0.17 (15th February, 2013)
+
+Bugfixes:
+
+    - Fix git plugin to work nicely with Cygwin and its unpredictable exit codes
+
+## 1.0.16 (13th February, 2013)
+
+Bugfixes:
+
+    - Reverted broken foodcritic plugin to that in 1.0.14
+
+## 1.0.15 (12th February, 2013)
+
+Bugfixes:
+
+    - Fixed git plugin so that when working on a submodule, submodules will be git pulled from the parent repo instead
+    - Fixed foodcritic plugin bug where certain tag formats weren't being passed through
+
+## 1.0.14 (15th January, 2013)
+
+Features:
+
+    -  Campfire plugin changed to use campy gem (thanks to Seth Vargo)
+    -  Organization name now added to messages when present (thanks to Seth Vargo)
+    -  Berkshelf support now added (thanks to Seth Vargo)
+
+Bugfixes:
+
+    - Promote won't try to create a version diff if there is no existing remote version (thanks to Seth Vargo)
+
+## 1.0.13 (9th January, 2013)
+
+Features:
+
+    -  Made spork promote Use environment_path from spork config if it's set( thanks to Greg Karékinian - https://github.com/gkarekinian)
+
+## 1.0.12 (22nd November, 2012)
+Bugfixes:
+
+    - Fix bug where cookbook dependancy loading broke in older chef client versions as a result of a fix in 1.0.10
+
+## 1.0.11 (22nd November, 2012)
+
+Yanked
+
+## 1.0.10 (22nd November, 2012)
+Bugfixes:
+
+    - Load all cookbook versions from remote server when checking dependencies (thanks to gmcmillan)
+    - Fix case where git plugin would update a previously loaded cookbook, resulting in out of data metadata being used. (thanks to zsol)
+
+## 1.0.9 (28th October, 2012)
+Features:
+
+    -  Jabber Plugin (thanks to Graham McMillan - https://github.com/gmcmillan)
+
+Bugfixes:
+
+    - Fix exception when spork promote called with no arguments (thanks to Julian Dunn - https://github.com/juliandunn)
+    
+## 1.0.8 (25th September, 2012)
+Bugfixes:
+
+    - Fix whitespace warnings which occur in the git plugin under Ruby 1.8
+    
+## 1.0.7 (25th September, 2012)
+Bugfixes:
+
+    - Fix invalid syntax in Hipchat plugin
+    
+## 1.0.6 (25th September, 2012)
+Bugfixes:
+
+    - Fix for disabling plugins when override config files are present
+    
+## 1.0.5 (24th September, 2012)
+Bugfixes:
+
+    - Fixes for hipchat plugin
+    
+## 1.0.4 (14th September, 2012)
+Features:
+
+    - Spork can now run command from any directory, not just the root of your chef repository.
+    
+Bugfixes:
+
+    - Fixed spork uploader to work more cleanly with 10.14.0 and greater
+    - Spork bump will no longer throw errors when no cookbook name is specified
+    
+## 1.0.3 (10th September, 2012)
+Bugfixes:
+
+    - Fix spork upload when using Chef 10.14.0
+    - Optional config override for chef environment location (not documented in README until 1.0.4)
+    
+## 1.0.2 (28th August, 2012)
+Bugfixes:
+
+    - Fix bug which caused plugin errors when no spork config file could be found
+    
+## 1.0.1 (27th August, 2012)
+Bugfixes:
+
+    - Fix require error which broke spork on CentOS 5.6
+    
+## 1.0.0 (27th August, 2012)
+Features:
+
+    - Major refactor (initial refactor: Seth Vargo)
+    - Plugin API (Seth Vargo)
+    - Added "spork info" command to show config hash and plugins status
+    - Missing local / remote cookbook now handled nicely in spork check
+    - Add "--fail" option to spork check to "exit 1" if check fails
+    - Git plugin now uses git gem instead of shelling out
+    - Confirmation check on promote if version jumps more than version_change_threshold
+    - Thanks also to jperry, bethanybenzur and nickmarden for contributions submitted pre-refactor which have been included in one form or another.
+
+    
+
+## 0.1.11 (5th June, 2012)
+Features:
+
+    - Hipchat Support (courtesy of Chris Ferry: @cdferry)
+
+Bugfixes:
+
+    - Tweaks to spork bump to play nicely with x.x versions as well as x.x.x (courtesy of Russ Garrett: @russss)
+
+## 0.1.10 (12th April, 2012)
+Features:
+
+    - All spork plugins now support multiple cookbook paths
+
+Bugfixes:
+
+    - Fixes to work with app_conf 0.4.0
+
+## 0.1.9 (3rd April, 2012)
+
+Features:
+
+    - Spork Promote will now git add updated environment files if git is enabled
+    - Spork Promote will optionally revert local changes to environment files if multiple changes were detected.
+    - Spork Bump will now perform a git pull and pull from submodules if git is enabled
+    - Optional Foodcritic integration added for Spork Upload
+    - ickymettle's Eventinator service now optionally supported
+
+Bugfixes:
+
+    - Correct irccat alerts to not fire if cookbook upload fails
+    - Code cleanup to remove unused Opscode code from Spork Upload
+
+## 0.1.8 (21st February, 2012)
+
+Features:
+
+    - Make promote --remote check if the correct version of the cookbook has been uploaded before updating the remote environment
+
+## 0.1.7 (21st February, 2012)
+
+Bugfixes:
+
+    - Make promote --remote work nicely when not run from chef repo root
+
+## 0.1.6 (21st February, 2012)
+Features:
+
+    - Spork Bump now defaults to "patch" if bump level not specified
+    - Spork Promote will prompt for confirmation if you're about to promote --remote changes to any cookbooks *other* than the one you specified on the command line. This should help avoid accidentally over-writing someone elses changes.
+    - Irccat messages now support multiple channels
+    - During promote, if git pull fails, ie a merge conflict has arisen, the error will be shown and promote will exit.
+    - Spork Promote will now also update git submodules before promoting. Specifically, it will run "git submodule foreach git pull"
+    - Failures during "git add" on spork bumps have a more helpful error message
+    - Irccat messages are now more nicely formatted and have pretty colours.
+
+Bugfixes:
+
+    - Spork Promote will now work from anywhere in your chef repo, not just the repo root
+
+## 0.1.5 (21st February, 2012)
+
+Yanked
+
+## 0.1.4 (3rd February, 2012)
+
+Features:
+
+    - Spork Check only show the last 5 remote versions, include the --all option if you want to see them all
+    - Spork will no longer work with Ruby 1.8. If you're on that version, the plugin will bail immediately.
+    - Spork now support updating a graphite metric when promote --remote is run
+    - Spork now supports alerting using irccat when a cookbook upload or promote --remote happens
+    - It will also optionally post a gist of version constraint changes in the above message when a promote --remote happens
+    - Added support for default environments to promote to
+    - knife-spork gemification thanks to Daniel Schauenberg
+
+Bugfixes:
+
+    - Various bugfixes and tweaks to formatting and log messages
+
+## 0.1.4 (3rd February, 2012)
+
+Yanked
+
+## 0.1.3 (3rd February, 2012)
+
+Yanked
+
+## 0.1.2 (3rd February, 2012)
+
+Yanked
+
+## 0.1.1 (3rd February, 2012)
+
+Yanked
+
+## 0.1.0 (January 28, 2012)
+
+Initial version.

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,35 @@
+KnifeSpork
+----------
+Author:: Jon Cowie (<jonlives@gmail.com>)
+Copyright:: Copyright (c) 2011 Jon Cowie
+License:: GPL
+
+Plugin API
+----------
+Author:: Seth Vargo (<svargo@customink.com>)
+Copyright:: Copyright (c) 2012 Seth Vargo
+License:: GPL
+
+Other
+-----
+spork bump is based on the knife-cookbook-bump plugin by:
+Alalanta (no license specified)
+
+With snippets from:
+Author:: Adam Jacob (<adam@opscode.com>)
+Author:: Christopher Walters (<cw@opscode.com>)
+Author:: Nuo Yan (<yan.nuo@gmail.com>)
+Copyright:: Copyright (c) 2009, 2010 Opscode, Inc.
+License:: Apache License, Version 2.0
+
+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

@@ -0,0 +1,406 @@
+KnifeSpork
+===========
+KnifeSpork is a workflow plugin for `Chef::Knife` which helps multiple developers work on the same Chef Server and repository without treading on each other's toes. This plugin was designed around the workflow we have here at Etsy, where several people are working on the Chef repository and Chef Server simultaneously. It contains several functions, documented below:
+
+[![Gem Version](https://badge.fury.io/rb/knife-spork.png)](http://badge.fury.io/rb/knife-spork)
+
+Installation
+------------
+
+### Gem Install
+`knife-spork` is available on rubygems. Add the following to your `Gemfile`:
+
+```ruby
+gem 'knife-spork'
+```
+
+or install the gem manually:
+
+```bash
+gem install knife-spork
+```
+
+**Please note**: As of version 1.3.0, knife-spork depends on version 11.0.0 or greater of the chef gem. If you're still using Chef 10, please continue to use knife-spork 1.2.x
+Spork Configuration
+-------------------
+Out of the box, knife spork will work with no configuration. However, you can optionally enable several features to enhance its functionality.
+
+KnifeSpork will look for a configuration file in the following locations, in ascending order of precedence:
+
+- `config/spork-config.yml`
+- `/etc/spork-config.yml`
+- `~/.chef/spork-config.yml`
+
+Anything set in the configuration file in your home directory for example, will override options set in your Chef repository or `/etc`.
+
+Below is a sample config file with all supported options and all shipped plugins enabled below, followed by an explanation of each section.
+
+```yaml
+default_environments:
+  - development
+  - production
+environment_groups:
+  qa_group:
+    - quality_assurance
+    - staging
+  test_group:
+    - user_testing
+    - acceptance_testing
+version_change_threshold: 2
+environment_path: "/home/me/environments"
+role_path: "/home/me/roles"
+custom_plugin_path: "/home/me/spork-plugins"
+always_promote_remote: true
+plugins:
+  campfire:
+    account: myaccount
+    token: a1b2c3d4...
+  foodcritic:
+    tags: ['any']
+  hipchat:
+    api_token: ABC123
+    rooms:
+      - General
+      - Web Operations
+    notify: true
+    color: yellow
+  jabber:
+    username: YOURUSER
+    password: YOURPASSWORD
+    nickname: Chef Bot
+    server_name: your.jabberserver.com
+    server_port: 5222
+    rooms:
+      - engineering@your.conference.com/spork
+      - systems@your.conference.com/spork
+  git:
+    enabled: true
+  irccat:
+    server: irccat.mydomain.com
+    port: 12345
+    gist: "/usr/bin/gist"
+    channel: ["chef-annoucements"]
+  graphite:
+    server: graphite.mydomain.com
+    port: 2003
+  eventinator:
+    url: http://eventinator.mydomain.com/events/oneshot
+```
+
+#### Default Environments
+The `default_environments` directive allows you to specify a default list of environments you want to promote changes to. If this option is configured and you *omit* the environment parameter when promoting KnifeSpork will promote to all environments in this list.
+
+#### Environment Groups
+The `environment_groups` directive allows you to specify a list of environments referenced by group names that you want to promote changes to.
+
+#### Version Change Threshold
+The `version_change_threshold` directive allows you to customise the threshold used by a safety check in spork promote which will prompt for confirmation if you're promoting a cookbook by more than version_change_threshold versions. This defaults to 2 if not set, ie promoting a cookbook from v1.0.1 to v 1.0.2 will not trip this check, wheras promoting from v1.0.1 to v1.0.3 will.
+
+#### Always Promote Remote
+The `always_promote_remote` directive allows you to tell spork promote to always act as if the --remote option had been specified. This will also have the same effect on spork omni. This option should only be used if you're sure you want all changes to be uploaded to the server as soon as you run promote.
+
+
+#### Environment Path
+The `environment_path` allows you to specify the path to where you store your chef environment json files. If this parameter is not specified, spork will default to using the first element of your cookbook_path, replacing the word "cookbooks" with "environments"
+
+#### Role Path
+The `role_path` allows you to specify the path to where you store your chef role json files. If this parameter is not specified, spork will default to using the first element of your cookbook_path, replacing the word "cookbooks" with "roles"
+
+#### Custom Plugin Path
+The `custom_plugin_path` allows you to specify an additional directory from which to load knife-spork plugins. If this parameter is not specified or the path set does not exist, only the default plugins shipped with knife-spork will be loaded (if enabled in config)
+
+
+#### Plugins
+Knife spork supports plugins to allow users to hook it into existing systems such as source control, monitoring and chat systems. Plugins are enabled / disabled by adding / removing their config block from the plugin section of the config file. Any of the default plugins shown above can be disabled by removing their section.
+
+For more information on how to develop plugins for spork, please read the [plugins/README.md](plugins/README.md) file.
+
+Spork Info
+-----------
+This function is designed to help you see which plugins you currently have loaded, and the current config Hash which knife spork is using.
+
+#### Usage
+```bash
+knife spork info
+```
+
+#### Example
+
+```text
+$ knife spork info
+Config Hash:
+{"plugins"=>{"git"=>{"enabled"=>true}, "irccat"=>{"server"=>"irccat.mydomain.com", "port"=>12345, "gist"=>"usr/bin/gist", "channel"=>["#chef-announce"]}, "graphite"=>{"server"=>"graphite.mydomain.com", "port"=>2003}, "eventinator"=>{"url"=>"http://eventinator.mydomain.com/events/oneshot"}}, "default_environments"=>["development", "production"], "version_change_threshold"=>2, "pplugins"=>{"foodcritic"=>{"fail_tags"=>["style,correctness,test"], "tags"=>["~portability"], "include_rules"=>["config/rules.rb"]}}}
+
+Plugins:
+KnifeSpork::Plugins::Campfire: disabled
+KnifeSpork::Plugins::Eventinator: enabled
+KnifeSpork::Plugins::Foodcritic: disabled
+KnifeSpork::Plugins::Git: enabled
+KnifeSpork::Plugins::Graphite: enabled
+KnifeSpork::Plugins::HipChat: disabled
+KnifeSpork::Plugins::Irccat: enabled
+```
+
+Spork Check
+-----------
+This function is designed to help you avoid trampling on other people's cookbook versions, and to make sure that when you come to version your own work it's easy to see what version numbers have already been used and if the one you're using will overwrite anything.
+
+#### Usage
+```bash
+knife spork check COOKBOOK [--all]
+```
+
+By default, spork check only shows the 5 most recent remote cookbook versions. Add the --all option if you want to see everything.
+
+#### Example (Checking an Unfrozen Cookbook with version clash)
+
+```text
+$ knife spork check apache2
+Checking versions for cookbook apache2...
+
+Local Version:
+  1.1.49
+
+Remote Versions: (* indicates frozen)
+ *2.0.2
+ *2.0.1
+  1.1.49
+ *1.1.14
+ *1.1.13
+
+ERROR: The version 1.1.49 exists on the server and is not frozen. Uploading will overwrite!
+```
+
+#### Example (Checking a Frozen Cookbook with version clash)
+
+```text
+$ knife spork check apache2
+Checking versions for cookbook apache2...
+
+Local Version:
+  2.0.2
+
+Remote Versions: (* indicates frozen)
+ *2.0.2
+ *2.0.1
+  1.1.49
+ *1.1.14
+ *1.1.13
+
+WARNING: Your local version (2.0.2) is frozen on the remote server. You'll need to bump before you can upload.
+````
+
+#### Example (No version clashes)
+
+```text
+$ knife spork check apache2
+Checking versions for cookbook apache2...
+
+Local Version:
+  2.0.3
+
+Remote Versions: (* indicates frozen)
+ *2.0.2
+ *2.0.1
+  1.1.49
+ *1.1.14
+ *1.1.13
+
+Everything looks good!
+```
+
+Spork Bump
+----------
+This function lets you easily version your cookbooks without having to manually edit the cookbook's `metadata.rb` file. You can either specify the version level you'd like to bump (`major`, `minor`, or `patch`), or you can manually specify a version number. This might be used if, for example, you want to jump several version numbers in one go and don't want to have to run knife bump once for each number. If no bump level is specified, a patch level bump will be performed.
+
+#### Usage
+```bash
+knife spork bump COOKBOOK [major | minor | patch | manual x.x.x]
+````
+
+#### Example (No patch level specified - defaulting to patch)
+```text
+$ knife spork bump apache2
+Successfully bumped apache2 to v2.0.4!
+```
+
+#### Example (Bumping patch level)
+```text
+$ knife spork bump apache2 patch
+Successfully bumped apache2 to v2.0.4!
+```
+
+#### Example (Manually setting version)
+```text
+$ knife spork bump apache2 manual 1.0.13
+Successfully bumped apache2 to v1.0.13!
+```
+
+Spork Upload
+------------
+This function works mostly the same as normal `knife cookbook upload COOKBOOK` except that this automatically freezes cookbooks when you upload them.
+
+#### Usage
+```bash
+knife spork upload COOKBOOK
+```
+#### Example
+```text
+$ knife spork upload apache2
+Freezing apache2 at 1.0.13...
+Successfully uploaded apache2@1.0.13!
+```
+
+Spork Promote
+-------------
+This function lets you easily set a version constraint in an environment or group of environments for a particular cookbook. By default it will set the version constraint to whatever the local version of the specified cookbook is. Optionally, you can include a `--version` option which will set the version constraint for the specified cookbook to whatever version number you provide. You might want to use this if, for example, you pushed a version constraint for a cookbook version you don't want your nodes to use anymore, so you want to "roll back" the environment to a previous version. You can also specify the `--remote` option if you'd like to automatically upload your changed local environment file to the server.
+
+If you don't specify an environment or environment group, the default_environments config directive will be used if set.
+
+#### Usage
+
+```bash
+knife spork promote [ENVIRONMENT OR ENVIRONMENT GROUP NAME] COOKBOOK [--version, --remote]
+```
+
+#### Example (Using local cookbook version number)
+
+```text
+$ knife spork promote my_environment apache2 --remote
+Adding version constraint apache2 = 1.0.13
+Saving changes to my_environment.json
+Uploading my_environment to Chef Server
+Promotion complete!
+```
+
+#### Example (Using manual version)
+```text
+$ knife spork promote my_environment apache2 -v 2.0.2
+Adding version constraint apache2 = 2.0.2
+Saving changes to my_environment.json
+Promotion complete. Don't forget to upload your changed my_environment to Chef Server
+```
+
+Spork Omni
+-------------
+Omni lets you combine one of the most common combinations of spork commands (bump, upload & promote or promote --remote) - into one handy shortcut.
+
+As omni is designed for use only in those cases where you want to perform all three of bump, upload and promote at the same time it supports a limited subset of the command line options supported by the individual bump, upload and promote commands.
+
+If you run omni with no extra options, it will default to performing a ```patch``` level bump, and promote locally to the environments listed in the ```default_environments``` variable in your spork configuration file.
+
+Alternatively, you can specify any of the following options:
+
+```--cookbook-path PATH:PATH```: A colon-separated path to look for cookbooks in
+
+```--include-dependencies```: Also upload cookbook dependencies during the upload step
+
+```--bump-level [major|minor|patch]```: Version level to bump the cookbook (defaults to patch)
+
+```--environment ENVIRONMENT```: Environment to promote the cookbook to',
+
+```--remote```: Make omni perform a promote --remote instead of a local promote',
+
+#### Usage
+
+```bash
+knife spork omni COOKBOOK [--bump-level, --cookbook-path, --include-dependencies, --environment, --remote]
+```
+
+#### Example (default options, default_environments set to development and production)
+
+```text
+$ knife spork omni apache2
+OMNI: Bumping apache2
+Successfully bumped apache2 to v0.3.99!
+
+OMNI: Uploading apache2
+Freezing apache2 at 0.3.99...
+Successfully uploaded apache2@0.3.99!
+
+OMNI: Promoting apache2
+Adding version constraint apache2 = 0.3.99
+Saving changes to development.json
+Promotion complete. Don't forget to upload your changed development.json to Chef Server
+Adding version constraint apache2 = 0.3.99
+Saving changes to production.json
+Promotion complete. Don't forget to upload your changed production.json to Chef Server
+```
+
+#### Example (default options, default_environments set to development and production, promote --remote)
+
+```text
+$ knife spork omni apache2 --remote
+OMNI: Bumping apache2
+Successfully bumped apache2 to v0.3.99!
+
+OMNI: Uploading apache2
+Freezing apache2 at 0.3.99...
+Successfully uploaded apache2@0.3.99!
+
+OMNI: Promoting apache2
+Adding version constraint apache2 = 0.3.99
+Saving changes to development.json
+Uploading development.json to Chef Server
+Promotion complete at 2013-08-08 11:43:12 +0100!
+Adding version constraint apache2 = 0.3.99
+Saving changes to production.json
+Uploading production.json to Chef Server
+Promotion complete at 2013-08-08 11:43:12 +0100!
+```
+
+#### Example (Specifying patch level and environment)
+```text
+$ knife spork omni apache2 -l minor -e development
+OMNI: Bumping apache2
+Successfully bumped apache2 to v0.4.0!
+
+OMNI: Uploading apache2
+Freezing apache2 at 0.4.0...
+Successfully uploaded apache2@0.4.0!
+
+OMNI: Promoting apache2
+Adding version constraint apache2 = 0.4.0
+Saving changes to development.json
+Promotion complete. Don't forget to upload your changed development.json to Chef Server
+```
+
+Spork Node / Role / Databag Commands
+-------------
+
+Knife spork contains "wrappers" around several stock knife commands for changing nodes, roles, environments and databags. These commands work exactly as in the original knife, with the addition of being wrapped in Spork's plugin API. This means that for example, when you upload a role using spork you will see an IRC message containing details, and a gist of the role change.
+
+The following  ```data bag``` commands are provided in knife-spork:
+```
+knife spork data bag create
+knife spork data bag delete
+knife spork data bag edit
+knife spork data bag from file
+```
+
+The following  ```node``` commands are provided in knife-spork:
+```
+knife spork node create
+knife spork node delete
+knife spork node edit
+knife spork node from file
+knife spork node run_list add
+knife spork node run_list remove
+knife spork node run_list set
+```
+
+The following  ```role``` commands are provided in knife-spork:
+```
+knife spork role create
+knife spork role delete
+knife spork role edit
+knife spork role from file
+```
+
+The following  ```environment``` commands are provided in knife-spork:
+```
+knife spork environment create
+knife spork environment delete
+knife spork environment edit
+knife spork environment from file
+```