Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms


magerun (7) Versions 2.2.6

installs/configures n98-magerun.phar

cookbook 'magerun', '~> 2.2.6'
cookbook 'magerun', '~> 2.2.6', :supermarket
knife supermarket install magerun
knife supermarket download magerun
Quality 50%


GitHub tag Build Status Gittip

chef-magerun installs n98-magerun and provides access to a corresponding LWRP.


Simply include the recipe in your application recipe, where you setup/deploy magento. ruby include_recipe "magerun"

ATTENTION: name this cookbook "magerun" if you want to use the LWRP like this: ruby magerun "PATH TO YOUR MAGENTO ROOT" do action :cache_flush end

See Command-Reference for available commands. Keep an eye on the associated actions in the LWRP (providers/default.rb) since some commands had to be rewritten using no "-".

As a sidenote for vagrant users: - You may set up a bash function to use a pseudo-tty with magerun in the vagrant box.

e.g. in your local ~/.bash_profile place: bash magerun () { vagrant ssh -- -t n98-magerun.phar --root-dir=/vagrant $@ }

Open a new bash prompt at your Vagrant project and interact with n98-magerun as if it were local. $ magerun help $ magerun cache:clean

Your commands will be run inside the Vagrant box using the n98-magerun config and Magento root defined. For performance reasons you might like to use the $ magerun shell feature rather than opening a new ssh connection for each command.


This cookbook depends on the following community cookbooks.

  • php


  • dop_php


The following platforms are supported and tested:

  • Debian 6.x
  • Debian 7.x
  • Ubuntu 14.04.x

Other Debian family distributions are assumed to work.


  1. Fork the repository from GitHub.
  2. Clone your fork to your local machine:

    $ git clone
  3. Create a git branch

    $ git checkout -b my_bug_fix
  4. Write tests

  5. Make your changes/patches/fixes, committing appropriately

  6. Run the tests: rake style, rake spec, rake integration:vagrant

  7. Push your changes to GitHub

  8. Open a Pull Request


The following Rake tasks are provided for automated testing of the cookbook:

$ rake -T
rake spec                 # Run ChefSpec examples
rake style                # Run all style checks
rake style:chef           # Lint Chef cookbooks
rake style:ruby           # Run Ruby style checks
rake travis               # Run all tests on Travis

See for detailed information.

License and Author

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

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.

Dependent cookbooks

php >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

CHANGELOG for magerun

This file is used to list changes made in each version of magerun.


  • use direct installation from url and remove git reference


  • housekeeping: update versions for test-kitchen
  • upgrade to new file location


  • fix install command (path)
  • use system-wide config
  • add locations of compressed sample data


  • fix installation of n98-magerun modules


  • Allow for 15 minute timout on magerun executions (tatemz)


  • Sample data during installation is marked by default. Created an option to turn off sample data. (tatemz)
  • Fixed find -exec bug. (tatemz)
  • Added output and debugging options. (tatemz)


  • update/integrate testsuites: test-kitchen, foodcritic, rubocop, travis-ci
  • prepare for release on


  • update install command: check for required php extensions (fixes #1 / thx tatemz)
  • add set_permissions action (fixes #2 / thx tatemz)


  • update install command


  • add overwrite config and set root user warning default to false


  • update/integrate testsuites: test-kitchen, foodcritic, rubocop, travis-ci


  • fix db:drop --force command


  • add role attribute to admin:user:create


  • add sys:setup:incremental command


  • remove composer entirely as its not needed here
  • move installation of magerun from LWRP to default recipe
  • fix commands


  • remove dependency to chef-php-extra by including own composer lwrp
  • add new magerun commands (v1.85.0)


  • Initial release of magerun

Collaborator Number Metric

2.2.6 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

2.2.6 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Foodcritic Metric

2.2.6 failed this metric

FC064: Ensure issues_url is set in metadata: magerun/metadata.rb:1
FC065: Ensure source_url is set in metadata: magerun/metadata.rb:1
FC066: Ensure chef_version is set in metadata: magerun/metadata.rb:1
FC069: Ensure standardized license defined in metadata: magerun/metadata.rb:1
FC085: Resource using new_resource.updated_by_last_action to converge resource: magerun/providers/default.rb:854
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

No Binaries Metric

2.2.6 passed this metric

Publish Metric

2.2.6 passed this metric

Supported Platforms Metric

2.2.6 passed this metric

Testing File Metric

2.2.6 passed this metric

Version Tag Metric

2.2.6 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must include a tag that matches this cookbook version number