community.general.homebrew_tap module – Tap a Homebrew repository

Note

This module is part of the community.general collection (version 7.0.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. You need further requirements to be able to use this module, see Requirements for details.

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

Comments

name

aliases: tap

list / elements=string / required

The GitHub user/organization repository to tap.

path

path

added in community.general 2.1.0

A : separated list of paths to search for brew executable.

Default: "/usr/local/bin:/opt/homebrew/bin:/home/linuxbrew/.linuxbrew/bin"

state

string

state of the repository.

Choices:

  • "present" ← (default)

  • "absent"

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.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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)