Skip to content

kmezynski/ansible-role-ohmyzsh

Repository files navigation

CI pre-commit.ci status License Code of Conduct Conventional Commits

Ansible Role: Oh My Zsh

Installs and configures Oh My Zsh with given plugins and theme on RHEL or Debian/Ubuntu servers.

Requirements

None.

Role Variables

Available variables are listed below, along with default values (refer to defaults and vars directories).

ohmyzsh_path: "{{ ansible_user_dir }}/.oh-my-zsh"
ohmyzsh_config_path: "{{ ansible_user_dir }}"

These variables control Oh My Zsh installation process:

  • ohmyzsh_path - path to Oh My Zsh installation directory.
  • ohmyzsh_config_path - path to Zsh shell initialization script.
ohmyzsh_autoupdate: false
ohmyzsh_autoupdate_frequency: 14
ohmyzsh_theme: robbyrussell
ohmyzsh_plugins:
  - git

Above variables configures Oh My Zsh after installation:

  • ohmyzsh_autoupdate - enables Oh My Zsh auto-updates.
  • ohmyzsh_autoupdate_frequency - auto-updates frequency for Oh My Zsh in days.
  • ohmyzsh_theme - name of official Oh My Zsh theme.
  • ohmyzsh_plugins - list of official Oh My Zsh plugins.

Dependencies

None.

Example Playbook

- hosts: all
  roles:
    - role: kmezynski.ohmyzsh
      ohmyzsh_path: "{{ ansible_user_dir }}/.config/zsh/.oh-my-zsh"
      ohmyzsh_config_path: "{{ ansible_user_dir }}/.config/zsh"
      ohmyzsh_autoupdate: true
      ohmyzsh_autoupdate_frequency: 30

License

This role is distributed under the terms of MIT license.

Author Information

This role was created in 2023 by Kamil Mężyński.