community.general.homebrew_tap – Tap a Homebrew repository.

Note

This plugin is part of the community.general collection (version 3.8.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.homebrew_tap.

Synopsis

  • Tap external Homebrew repositories.

Requirements

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

  • homebrew

Parameters

Parameter Choices/Defaults Comments
name
list / elements=string / required
The GitHub user/organization repository to tap.

aliases: tap
path
path
added in 2.1.0 of community.general
Default:
"/usr/local/bin:/opt/homebrew/bin"
A ':' separated list of paths to search for brew executable.
state
string
    Choices:
  • present ←
  • absent
state of the repository.
url
string
The optional git URL of the repository to tap. The URL is not assumed to be on GitHub, and the protocol doesn't have to be HTTP. Any location and protocol that git can handle is fine.
name option may not be a list of multiple taps (but a single tap instead) when this option is provided.

Examples

- name: Tap a Homebrew repository, state present
  community.general.homebrew_tap:
    name: homebrew/dupes

- name: Tap a Homebrew repository, state absent
  community.general.homebrew_tap:
    name: homebrew/dupes
    state: absent

- name: Tap a Homebrew repository, state present
  community.general.homebrew_tap:
    name: homebrew/dupes,homebrew/science
    state: present

- name: Tap a Homebrew repository using url, state present
  community.general.homebrew_tap:
    name: telemachus/brew
    url: 'https://bitbucket.org/telemachus/brew'

Authors

  • Indrajit Raychaudhuri (@indrajitr)

  • Daniel Jaouen (@danieljaouen)