params.json

{
  "name": "Itamae",
  "tagline": "Configuration management tool inspired by Chef, but simpler and lightweight. Formerly known as Lightchef.",
  "body": "# [![](https://raw.githubusercontent.com/itamae-kitchen/itamae-logos/master/small/FA-Itamae-horizontal-01-180x72.png)](https://github.com/itamae-kitchen/itamae)\r\n\r\n[![Gem Version](https://badge.fury.io/rb/itamae.svg)](http://badge.fury.io/rb/itamae) [![Code Climate](https://codeclimate.com/github/ryotarai/itamae/badges/gpa.svg)](https://codeclimate.com/github/ryotarai/itamae) [![Build Status](https://travis-ci.org/itamae-kitchen/itamae.svg?branch=master)](https://travis-ci.org/itamae-kitchen/itamae) [![Slack](https://img.shields.io/badge/slack-join-blue.svg)](https://itamae-slackin.herokuapp.com/)\r\n\r\nSimple and lightweight configuration management tool inspired by Chef.\r\n\r\n- [CHANGELOG](https://github.com/itamae-kitchen/itamae/blob/master/CHANGELOG.md)\r\n\r\n## Concept\r\n\r\n- Chef-like DSL (but not compatible with Chef)\r\n- Simpler and lighter weight than Chef\r\n- Only recipes\r\n- Idempotent\r\n\r\n## Installation\r\n\r\n```\r\n$ gem install itamae\r\n```\r\n\r\n## Getting Started\r\n\r\nCreate a recipe file as `recipe.rb`:\r\n\r\n```ruby\r\npackage 'nginx' do\r\n  action :install\r\nend\r\n\r\nservice 'nginx' do\r\n  action [:enable, :start]\r\nend\r\n```\r\n\r\nAnd then excute `itamae` command to apply a recipe to a local machine.\r\n\r\n```\r\n$ itamae local recipe.rb\r\n INFO : Starting Itamae...\r\n INFO : Recipe: /home/user/recipe.rb\r\n INFO :    package[nginx]\r\n INFO :       action: install\r\n INFO :          installed will change from 'false' to 'true'\r\n INFO :    service[nginx]\r\n INFO :       action: enable\r\n INFO :       action: start\r\n```\r\n\r\nOr you can apply a recipe to a remote machine by `itamae ssh`.\r\n\r\n```\r\n$ itamae ssh --host host001.example.jp recipe.rb\r\n```\r\n\r\nYou can also apply a recipe to Vagrant VM by `itamae ssh --vagrant`.\r\n\r\n```\r\n$ itamae ssh --vagrant --host vm_name recipe.rb\r\n```\r\n\r\nYou can find further information to use Itamae on [Itamae Wiki](https://github.com/itamae-kitchen/itamae/wiki).\r\n\r\nEnjoy!\r\n\r\n## Documentation\r\n\r\nhttps://github.com/itamae-kitchen/itamae/wiki\r\n\r\n## Run tests\r\n\r\nRequirements: Vagrant\r\n\r\n```\r\n$ bundle exec rake spec\r\n```\r\n\r\n## Get Involved\r\n\r\n- [Join Slack team](https://itamae-slackin.herokuapp.com/)\r\n\r\n## Presentations / Articles\r\n\r\n### in Japanese\r\n\r\n- [Itamae - Infra as Code 現状確認会](https://speakerdeck.com/ryotarai/itamae-infra-as-code-xian-zhuang-que-ren-hui)\r\n- [クックパッドのサーバプロビジョニング事情 - クックパッド開発者ブログ](http://techlife.cookpad.com/entry/2015/05/12/080000)\r\n- [Itamaeが構成管理を仕込みます！ ～新進気鋭の国産・構成管理ツール～：連載｜gihyo.jp … 技術評論社](http://gihyo.jp/admin/serial/01/itamae)\r\n\r\n\r\n## Contributing\r\n\r\nIf you have a problem, please [create an issue](https://github.com/itamae-kitchen/itamae/issues/new) or a pull request.\r\n\r\n1. Fork it\r\n2. Create your feature branch (`git checkout -b my-new-feature`)\r\n3. Commit your changes (`git commit -am 'Add some feature'`)\r\n4. Push to the branch (`git push origin my-new-feature`)\r\n5. Create new Pull Request\r\n\r\n",
  "note": "Don't delete this file! It's used internally to help with page regeneration."
}