Skip to content
Ansible role for installing and configuring oh-my-zsh
Shell Python
Branch: master
Clone or download
freemanjp Increased minimum Ansible version to 2.6 (#88)
Ansible no longer supports versions earlier than 2.6.
Latest commit 5f783bf Jul 21, 2019

Ansible Role: Oh My Zsh

Build Status Ansible Galaxy License

Role to download, install and configure Oh-My-Zsh.

Note: you may be better off using the alternative gantsign.ansible_role_antigen role that can install third-party Zsh plugins as well as installing Oh My Zsh and its plugins.


  • Ansible >= 2.6

  • Linux Distribution

    • Debian Family

      • Debian

        • Jessie (8)
        • Stretch (9)
      • Ubuntu

        • Trusty (14.04)
        • Xenial (16.04)
        • Bionic (18.04)
    • RedHat Family

      • CentOS

        • 7
      • Fedora

        • 28
    • SUSE Family

      • openSUSE

        • 15.0
    • Note: other versions are likely to work but have not been tested.

Role Variables

The following variables will change the behavior of this role (default values are shown below):

# Default theme
oh_my_zsh_theme: robbyrussell

# Default plugins
  - git

# User configuration
# Important: oh-my-zsh is installed per user so you need to specify the users to install it for.
  - username: example1
      theme: robbyrussell
        - git
  - username: example2
      theme: robbyrussell
        - git
        - mvn

Example Playbook

- hosts: servers
    - role: gantsign.oh-my-zsh
        - username: example

More Roles From GantSign

You can find more roles from GantSign on Ansible Galaxy.

Development & Testing

This project uses Molecule to aid in the development and testing; the role is unit tested using Testinfra and pytest.

To develop or test you'll need to have installed the following:

Because the above can be tricky to install, this project includes Molecule Wrapper. Molecule Wrapper is a shell script that installs Molecule and it's dependencies (apart from Linux) and then executes Molecule with the command you pass it.

To test this role using Molecule Wrapper run the following command from the project root:

./moleculew test

Note: some of the dependencies need sudo permission to install.



Author Information

John Freeman

GantSign Ltd. Company No. 06109112 (registered in England)

You can’t perform that action at this time.