fish Puppet Module

Build Status

Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with fish
  4. Usage - Configuration options and additional functionality
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Overview

Puppet module for installing, configuring, and managing Fish, "fish is a smart and user-friendly command line shell for OS X, Linux, and the rest of the family."

Finally, a command line shell for the 90s

Module Description

This module manages the installation of Fish.

If you'd prefer, you can also disable the repo after the agent's been installed, or opt out of repo management altogether.

Setup

What fish affects

By default, this module will:

  • Set up the package repository
  • Install the Fish package

Beginning with fish

Repositories are maintained seperately:

Full docs are avaliable here: https://fishshell.com/docs/current/index.html

Usage

This module includes a single class:

include '::fish'

You'll more than likely want to provide the appropriate values for your setup.

To opt out of repo management altogether, you'd specify it like so:

class { '::fish':
  manage_repo => false,
}

For more detailed information about parameters, you can read the docs

Limitations

  • Arch support is currently not implemented.

Development

If you'd like to other features or anything else, check out the contributing guidelines in CONTRIBUTING.md.