REFERENCE.md

Reference

Table of Contents

Classes

• ohmyzsh: Install and configure Oh-My-ZSH

Defined types

• ohmyzsh::fetch::theme: Install a theme from a defined source
• ohmyzsh::install: Install and configure Oh-My-ZSH for an user
• ohmyzsh::plugins: Install and configure Oh-My-ZSH plugins for an user
• ohmyzsh::profile: Configure the ZSH profile for an user
• ohmyzsh::theme: Configure the ZSH theme for an user

Classes

ohmyzsh

This is the ohmyzsh module. It creates a profile directory under user home and allows custom scripts to setup and made avalible on the path.

This module is called ohmyzsh as Puppet does not support hyphens in module names.

View README.md for full documentation.

Parameters

The following parameters are available in the ohmyzsh class:

• source
• home
• zsh_shell_path
• installs
• themes
• plugins
• profiles

source

Data type: Stdlib::Httpsurl

Oh-My-ZSH repository. See data/ for the default value.

home

Data type: Stdlib::Absolutepath

Default home base directory. See data/ for the default value.

zsh_shell_path

Data type: Stdlib::Absolutepath

Path of the zsh executable. See data/ for the default value.

installs

Data type: Hash

Install and configure Oh-My-ZSH for users defined in this hash. See data/ for the default value.

themes

Data type: Hash

Configure the themes for users defined in this hash. See data/ for the default value.

plugins

Data type: Hash

Configure the plugins for users defined in this hash. See data/ for the default value.

profiles

Data type: Hash

Configure the profile for users defined in this hash. See data/ for the default value.

Defined types

ohmyzsh::fetch::theme

Install a theme from a defined source

Parameters

The following parameters are available in the ohmyzsh::fetch::theme defined type:

• url
• source
• content
• filename
• revision
• depth

url

Data type: Optional[Stdlib::Httpurl]

The URL of the git repository (if source is git) or to the file

Default value: undef

source

Data type: Optional[String]

git for a repository, undef for a file to download or the source to pass to Puppet file

Default value: undef

content

Data type: Optional[String]

The content to pass to Puppet file, only if source and url is unset.

Default value: undef

filename

Data type: Optional[String]

The file name to use while saving the theme

Default value: undef

revision

Data type: Optional[String]

Revision to checkout while using Git

Default value: undef

depth

Data type: Optional[Integer]

Controls the shallow clone for Git

Default value: undef

ohmyzsh::install

Install and configure Oh-My-ZSH for an user

Parameters

The following parameters are available in the ohmyzsh::install defined type:

• ensure
• set_sh
• update_zshrc
• backup_zshrc
• auto_update_mode
• auto_update_frequency

ensure

Data type: Enum[present, latest]

Controls the way the Oh-My-ZSH repository is managed by Puppet.

Default value: latest

set_sh

Data type: Boolean

Controls whether to change the user shell to zsh.

Default value: false

update_zshrc

Data type: Enum[always, disabled, sync]

Controls the update of .zshrc from the upstream template.

Default value: disabled

backup_zshrc

Data type: Boolean

Controls if a backup of .zshrc need to be sone before changes.

Default value: true

auto_update_mode

Data type: Enum[auto, disabled, reminder]

Controls the update check for oh-my-zsh.

Default value: disabled

auto_update_frequency

Data type: Integer[0]

Controls the update check frequency.

Default value: 14

ohmyzsh::plugins

Install and configure Oh-My-ZSH plugins for an user

Parameters

The following parameters are available in the ohmyzsh::plugins defined type:

• plugins
• custom_plugins

plugins

Data type: Array[String]

List of built-in plugins.

Default value: ['git']

custom_plugins

Data type: Hash[String, Struct[ { source => Enum[git], url => Stdlib::Httpsurl, ensure => Enum[present, latest], revision => Optional[String], depth => Optional[Integer] } ] ]

List of plugins to install and use.

Default value: {}

ohmyzsh::profile

Configure the ZSH profile for an user

Parameters

The following parameters are available in the ohmyzsh::profile defined type:

• scripts

scripts

Data type: Hash[String[1], Stdlib::Filesource]

A hash of name => paths to all the scripts.

Default value: {}

ohmyzsh::theme

Configure the ZSH theme for an user

Parameters

The following parameters are available in the ohmyzsh::theme defined type:

• theme

theme

Data type: String

The name of the theme to use.

Default value: 'clean'