colorprompt

Add colors to your bash prompt

denver

denver

2,152 downloads

2,152 latest version

4.9 quality score

Version information

  • 2.1.3 (latest)
released Nov 14th 2019
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >=3.0.0 < 7.0.0
  • RedHat, CentOS, OracleLinux, Fedora, Debian, Ubuntu

Start using this module

Documentation

denver/colorprompt — version 2.1.3 Nov 14th 2019

colorprompt

Overview

Build Status Code Coverage Puppet Forge Puppet Forge - downloads Puppet Forge - scores

The colorprompt module. Colors your bash prompt.

This is a fork of https://forge.puppet.com/sgnl05/colorprompt v2.1.2, original credit goes to the matainer(s) of sgnl05-colorprompt.

Module Description

The colorprompt module creates /etc/profile.d/colorprompt.sh, which sets a colored prompt. Different colors can be set for (all and specific) users, server name and environment tag.

Usage

All interaction with the colorprompt module can be done through the main colorprompt class.

I just want a colored prompt, what's the minimum I need?

include 'colorprompt'

I want a prompt for my production server with customised colors.

class { 'colorprompt':
   env_name          => 'PROD',
   env_color         => ['white', 'bg_red'],
   server_color      => 'red',
   default_usercolor => 'cyan',
   custom_usercolors => {
     'root' => 'magenta',
   },
}

Great! What colors are available?

  • black
  • red
  • green
  • yellow
  • blue
  • magenta
  • cyan
  • white

A background color can also be defined by using bg_(color). Foreground and background colors can be combined by using arrays instead of strings (see env_color in example above).

Reference

Classes

Public Classes

  • colorprompt: Main and only class.

###Parameters

ensure

String. Ensure if file /etc/profile.d/colorprompt.sh is present or absent. Defaults to present.

default_usercolor

String or array. Sets the color for all users. Specific user colors can be overrided by 'custom_usercolors'. Defaults to 'cyan'.

custom_usercolors

Hash. Sets the color for specific users. Example: custom_usercolors => { 'apache' => 'blue', 'tomcat' => 'yellow' } Default is { 'root' => 'magenta' }

server_color

String or array. Sets the color for the server name. Defaults to unset.

env_name

String: Names an environment tag. Examples: 'PROD', 'QA', 'TEST', 'DEV'. Defaults to unset.

env_color

String or array. Sets the color for of the environment tag. Defaults to unset

prompt

String. Sets the final PS1 variable. This is an advanced setting, and should probably be left untouched unless you know what you're doing. :) Default varies with osfamily.

modify_skel

Boolean. Comments out PS1 variables in /etc/skel/.bashrc Default varies with osfamily.

modify_root

Boolean. Comments out PS1 variables in /root/.bashrc Default varies with osfamily

Limitations

This module has been tested against Puppet 3.0 and higher.

The module has been tested on:

  • RedHat & CentOS 5/6/7
  • Ubuntu 12.04 & 14.04
  • Debian 6/7/8
  • Fedora 22/23

Ubuntu and Debian need modification to existing user ~/.bashrc files (comment out PS1 variables).

Development

To execute acceptance tests...

PUPPET_INSTALL_TYPE=agent BEAKER_PUPPET_COLLECTION=puppet5 BEAKER_debug=true BEAKER_set=docker/centos-7 bundle exec rake beaker
PUPPET_INSTALL_TYPE=agent BEAKER_PUPPET_COLLECTION=puppet5 BEAKER_debug=true BEAKER_set=docker/ubuntu-18.04 bundle exec rake beaker

For this to work you must have docker installed and running locally

Contributing

Please use the issue tracker (https://github.com/dmcanally/denver-colorprompt/issues) for any type of contribution.