Git Product home page Git Product logo

puppet-ohmyzsh's Introduction

rehan-ohmyzsh

Puppet Forge Build Status

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Dependencies
  6. Development
  7. Acknowledgments

Overview

This is a oh-my-zsh module. It installs oh-my-zsh for a user and can change their shell to zsh. It can install and configure themes and plugins for users.

Module Description

oh-my-zsh is a community-driven framework for managing your zsh configuration. See https://github.com/robbyrussell/oh-my-zsh for more details.

Setup

In order to install rehan-ohmyzsh, run the following command:

$ puppet module install rehan-ohmyzsh

The module does expect all the data to be provided through 'Hiera'. See Usage for examples on how to configure it.

Requirements

This module is designed to be as clean and compliant with latest puppet code guidelines.

Usage

# for a single user
ohmyzsh::install { 'user1': }

# for multiple users in one shot and set their shell to zsh
ohmyzsh::install { ['root', 'user1']: set_sh => true }

# install and disable prompt for automatic updates
ohmyzsh::install { 'user2': auto_update_mode => disabled }

# install and sync the .zshrc when upstream project is updated.
ohmyzsh::install { 'user2': update_zshrc => sync }

# install a theme for a user
ohmyzsh::fetch::theme { 'root': url => 'http://zanloy.com/files/dotfiles/oh-my-zsh/squared.zsh-theme' }

# set a theme for a user
ohmyzsh::theme { ['root', 'user1']: } # would install 'clean' theme as default

ohmyzsh::theme { ['root', 'user1']: theme => 'robbyrussell' } # specific theme

# activate plugins for a user
ohmyzsh::plugins { 'user1': plugins => ['git', 'github'] }

YAML

ohmyzsh::installs:
  alice:
    set_sh: true
  bob:
    set_sh: true

ohmyzsh::themes:
  alice:
    theme: 'random'
  bob:
    theme: 'amuse'

ohmyzsh::plugins:
  alice:
    plugins: ['autojump', 'git', 'screen', 'ssh-agent', 'sudo', 'tmux' ]
    custom_plugins:
      zsh-syntax-highlighting:
       ensure: latest
       source: git
       url:    'https://github.com/zsh-users/zsh-syntax-highlighting.git'
      zsh-autosuggestions:
       ensure: latest
       source: git
       url:    'https://github.com/zsh-users/zsh-autosuggestions.git'
  bob:
    plugins: ['autojump', 'git', 'screen', 'ssh-agent', 'sudo', 'tmux', 'vagrant', 'scala', 'rvm' ]

Dependencies

Development

You can submit pull requests and create issues through the official page of this module on GitHub. Please do report any bug and suggest new features/improvements.

Acknowledgments

This module was originally a fork of zanloy/ohmyzsh at version 0.1.3

puppet-ohmyzsh's People

Contributors

acme avatar anthonysomerset avatar dctrotz avatar liquorvicar avatar randellp avatar rehanone avatar zanloy avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.