Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

antigen

Installs antigen to easily manage your zsh plugins, called bundles (e.g. oh-my-zsh).
Project URLRSS FeedReport issues

8,438 downloads

7,847 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.1.2 (latest)
  • 0.1.1
  • 0.1.0
released Oct 25th 2015
This version is compatible with:
  • ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'lukrop-antigen', '0.1.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add lukrop-antigen
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install lukrop-antigen --version 0.1.2

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

lukrop/antigen — version 0.1.2 Oct 25th 2015

lukrop-antigen puppet module

Table of Contents

  1. Overview
  2. Setup
  3. Usage
  4. Reference

Overview

Installs antigen to easily manage your zsh plugins, called bundles (e.g. oh-my-zsh).

Setup

From the puppet forge:

$ puppet module install lukrop-antigen

Or simply clone this git repository:

$ git clone https://github.com/lukrop/puppet-lukrop-antigen.git $MODULES_PATH/antigen

What antigen affects

This module..

  • clones the antigen git repository to $HOME/.antigen
  • creates a file $HOME/.antigen-puppet.zsh which contains the appropriate antigen commands to apply a theme, use a library and bundles.
  • creates a line in $HOME/.zshrc containing source $HOME/.antigen-puppet.zsh. If $HOME/.zshrc is not present it will be created.
  • changes the given user's shell to zsh

$HOME is the home directory of the supplied user.

Usage

# include base class
include antigen

# install for a single user with defaults
antigen::install { 'lukrop': }

# install for a single user with specified theme and bundles
antigen::install { 'lukrop':
  theme => 'mrtazz',
  bundles => ['git', 'ruby'],
}

# install for multiple users
antigen::install { ['root', 'lukrop']: }

# update all bundles for a user
antigen::update { 'lukrop': }

# selfupdate (update antigen itself)
antigen::selfupdate { ['lukrop', 'root']: }

Reference

antigen parameters:

  • zsh path to zsh binary.
  • home base path for users home directories.
  • git_pkg optionally supply the name of the git package to be installed. Default: 'git'.
  • zsh_pkg optionally supply the name of the zsh package to be installed. Default: 'zsh'.

Both, zsh and home have sensible defaults depending on $::operatingsystem. Supported are GNU/Linux, BSD and Darwin.

antigen::install parameters:

  • user user for whom to install antigen. If none is supplied the resource name is used.
  • library which zsh base library to use. Options are 'oh-my-zsh' or 'prezto'. Default: 'oh-my-zsh'
  • theme name of the zsh prompt theme. Default: 'clean'
  • bundles list of bundles to use. Default: ['git']
  • auto_update if using oh-my-zsh as base library, whether to automatically update oh-my-zsh. This just exports DISABLE_AUTO_UPDATE=true. Default: true.
  • update_prompt if using oh-my-zsh as base library, whether to show the update prompt. This just exports DISABLE_UPDATE_PROMPT=true. Default: true.
  • force_replace overwrites existing .zshrc. Default: false.