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

Select Status


macos (52) Versions 2.6.0

Resources for configuring and provisioning macOS

cookbook 'macos', '= 2.6.0', :supermarket
cookbook 'macos', '= 2.6.0'
knife supermarket install macos
knife supermarket download macos
Quality 100%

macOS Cookbook


Chef resources and recipes for managing and provisioning macOS.

Supported Chef Versions

  • Chef 13
  • Chef 14

Supported OS Versions

  • OS X El Capitan 10.11
  • macOS Sierra 10.12
  • macOS High Sierra 10.13


Admin User and Password

node['macos']['admin_user'] = 'vagrant'
node['macos']['admin_password'] = 'vagrant'

Each of these attributes defaults to vagrant since our resources are developed
with the Vagrant paradigm. In other words, the user and password declared here
should be an admin user with passwordless super-user rights.


Disable Software Updates

Disables automatic checking and downloading of software updates.

Usage: include_recipe 'macos::disable_software_updates'

No attributes used in this recipe.

Keep Awake

Prevent macOS from falling asleep, disable the screensaver, reboot upon power failure,
enable wake on LAN, enable remote login (SSH) and adjust several other settings
to always keep macOS on and available.

Usage: include_recipe 'macos::keep_awake'

Attributes used Default value
node['macos']['remote_login_enabled'] true
node['macos']['network_time_server'] ''
node['macos']['time_zone'] 'America/Los_Angeles'


Installs Xcode 9.2 and simulators for iOS 10 and iOS 11. See the
Xcode resource documentation if you need
more flexibility.

:warning: Requires a credentials data bag containing an apple_id data bag item,
or a user/password pair set under node['macos']['apple_id'].

Usage: include_recipe 'macos::xcode'

Attributes used Default value
node['macos']['xcode']['version'] '9.3'
node['macos']['xcode']['simulator']['major_version'] nil
node['macos']['apple_id']['user'] nil
node['macos']['apple_id']['password'] nil

Data Bags

The macos::xcode recipe can utilize a credentials data bag with an apple_id
data bag item. The item should contain valid Apple ID credentials. For example:


  "id": "apple_id",
  "apple_id": "",
  "password": "0k@yN0cR34m"


Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

vsts_agent_macos Applicable Versions


All notable changes to this project will be documented in this file.

[2.6.0] - 2018-10-03


  • Apple has limited some kickstart command functionality in macOS Mojave, preventing screen
    control in some invocations. We verified the ard resource's implementation of the kickstart script still functions.

  • Updated Xcode default version to 10.0.

  • The team crossed the great Mojave Desert, collapsed from dehydration, all just to obtain its support. In other words we now support macOS Mojave.


  • Prevented the xcode resource from leaving available Command Line Tools downloads in Software Updates.


  • The machine_name resource has been deprecated in favor of the macOS support in the hostname resource in Chef 14. It will be removed in the release of v3.0 of the macOS cookbook.

[2.5.0] - 2018-09-10


  • Added, About time right? (Issue #122).
  • Added functional path property to Xcode resource. (Issue #116).
  • Added ChefSpec resource tests for Xcode.


  • Separated extra responsibilities of Xcode resource into DeveloperAccount and CommandLineTools libraries.

[2.4.0] - 2018-08-16



  • homebrew cookbook dependency removed. homebrew_cask and homebrew_tap is being deprecated by Chef and has not been used by macos-cookbook since version 2.0. (Issue #123).


  • Fixed keychain resource documentation link.
  • Update metadata_util library to consider Spotlight server status before manipulating indexing state. (Issue #45).

[2.3.0] - 2018-06-28


  • Like a trained ninja of the night, the macos_user now has a hidden property, making it impossible to detect from the login screen.
  • Moved to a new set of internal Vagrant macOS boxes, which have much more minimal initial configuration. This ensures that our resources run from a more out-of-the-box macOS experience.


  • Fixed bug where deletion of a user was failing when using the macos_user resource.
  • For those of you who like to set their user and password as the same characters, we fixed an issue in the certificate resource for non-Vagrant use cases, you know for normal human beings who like a secure environment.

[2.2.0] - 2018-05-29


  • Foodcritics can be pretty harsh in their critiquing of food. They also have some pretty in depth rules we need to comply with, so we updated machine_name to comply with the new FoodCritic rule FC115.
  • Added guard config to automatically run relevant unit tests when a file is changed.
  • Update to InSpec control filenames to match the standard. This allows for better understanding of the tests.

[2.1.0] - 2018-05-16


  • Created an autologin functionality on 10.13.4 to allow for machine to automatically login to the machine.

[2.0.0] - 2018-05-09


  • Removed the Mono recipe as it is not in the scope of this cookbook.
  • Removed Apple Configurator recipe as a bug with the mas dependency does not function in High Sierra.

[1.14.0] - 2018-05-01


  • Updated the keep_awake recipe and spec tests to not require node attribute stubbing when wrapped in another cookbook.

[1.13.0] - 2018-04-25


  • Added a to outline the Chef Community Guidelines for code contribution.


  • Fixed an issue with ChefSpec when wrapping the keep_awake recipe.
  • Fixed an idempotence issue with the keychain resource.

[1.12.0] - 2018-04-16


  • Added new keychain resource
  • Introduced three new library classes Power, Environment, and ScreenSaver.
  • Updated to reflect single build definition.
  • Added feature to make disk sleep default to Never.

[1.11.0] - 2018-04-11


  • Added the ability to install Xcode beta builds to the xcode resource.
  • Added support for Chef 14.

[1.10.0] - 2018-03-26


  • Added feature that allows node attributes to be set for Developer Apple ID credentials while downloading Xcode from Apple.
  • Added ability to install Command Line tools from the xcode-install gem.


  • Increased timeout for Xcode download for issue where method bundle_version_correct fails and unsuccessfully tries to access node attributes in Xcode library.
  • Resolved issue where adding users and groups would fail tests.

[1.9.0] - 2018-03-21


  • Added support for other hypervisors and keep away logic.
  • Implemented -t option in certificate resource to allow apps to access imported key.
  • Add utf-8 encoding type to plist resource to make it more robust.

[1.8.0] - 2018-03-12


  • Added a dns_domain property to machine_name resource to support FQDNs.
  • Added documentation.
  • Changed binary property to encoding to support xml and binary plist formats.


  • Removed support for NetBIOSName due to macOS bugs.


  • Fixed several bugs in plist resource.
  • Fixed typos in machine_name resource documentation.

[1.7.0] - 2018-03-05


  • Added the certificate resource, this resource manages the state of a given certificate for a specified keychain.

[1.6.0] - 2018-02-20


  • Added whitespace support for property list names and keys.


  • Fixed some depreciation bugs in the macos_user resource.
  • Fixed idempotency bug in .kitchen.yml.

[1.5.0] - 2018-02-12


  • Added new system_preference resource.


  • Removed systemsetup resource.
  • Removed .delivery in favor of kitchen test and concurrency testing model.


  • Fixed issue where plist resources cause incomplete idempotence on second converge by making the keep_awake recipe idempotent. (Issue #15).
  • Fixed issue where macos_user was not allowing users to be added to groups by creating a new groups property. (Issue #40).
  • Fixed issue where machine_name resource does not set LocalHostName by making machine_name idempotent and having it properly set the LocalHostName. (Issue #20).

[1.3.0] - 2018-02-02


  • Added helper modules for systemsetup.
  • Added new attributes to adjust the keep_awake functions.
  • Added better functionality to the keep_awake power resources.

[1.2.0] - 2018-01-28


  • Initial release of the macOS Cookbook.
  • Chef support for 10.10 to 10.13.
  • Added xcode resource.
  • Added keep_awake recipe.
  • Added spotlight resource.
  • Added machine_name resource.
  • Added macos_user resource.

Collaborator Number Metric

2.6.0 passed this metric

Contributing File Metric

2.6.0 passed this metric

Foodcritic Metric

2.6.0 passed this metric

No Binaries Metric

2.6.0 passed this metric

Testing File Metric

2.6.0 passed this metric

Version Tag Metric

2.6.0 passed this metric