Documentation

homebrew_cask - Install/uninstall homebrew casks.

New in version 1.6.

Synopsis

  • Manages Homebrew casks.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
accept_external_apps
(added in 2.5.0)
Default:
no
allow external apps
install_options
(added in 2.2)
Default:
None
options flags to install a package

aliases: options
name
required
name of cask to install/remove

aliases: pkg, package, cask
path Default:
/usr/local/bin
':' separated list of paths to search for 'brew' executable.
state
    Choices:
  • present ←
  • absent
  • upgraded
state of the cask
update_homebrew
(added in 2.2)
    Choices:
  • yes
  • no ←
update homebrew itself first. Note that brew cask update is a synonym for brew update.

aliases: update-brew
upgrade
(added in 2.5.0)
Default:
no
upgrade all casks (mutually exclusive with `upgrade_all`)
upgrade_all
(added in 2.5.0)
Default:
no
upgrade all casks (mutually exclusive with `upgrade`)

Examples

- homebrew_cask:
    name: alfred
    state: present

- homebrew_cask:
    name: alfred
    state: absent

- homebrew_cask:
    name: alfred
    state: present
    install_options: 'appdir=/Applications'

- homebrew_cask:
    name: alfred
    state: present
    install_options: 'debug,appdir=/Applications'

- homebrew_cask:
    name: alfred
    state: present
    allow_external_apps: True

- homebrew_cask:
    name: alfred
    state: absent
    install_options: force

- homebrew_cask:
    upgrade_all: true

- homebrew_cask:
    name: alfred
    state: upgraded
    install_options: force

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Indrajit Raychaudhuri (@indrajitr)
  • Daniel Jaouen (@danieljaouen)
  • Enric Lluelles (@enriclluelles)

Hint

If you notice any issues in this documentation you can edit this document to improve it.