Forge Home


A puppet class to handle tmux installation and configuration.


21,008 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.

Version information

  • 1.0.2 (latest)
  • 1.0.1
  • 1.0.0
  • 0.1.1
  • 0.1.0
released Jun 22nd 2015
This version is compatible with:
  • CentOS, Debian, RedHat, Ubuntu

Start using this module

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

Add this module to your Puppetfile:

mod 'zanloy-tmux', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add zanloy-tmux
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install zanloy-tmux --version 1.0.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.



zanloy/tmux — version 1.0.2 Jun 22nd 2015


Build Status

Manage tmux via puppet.

tmux is a terminal multiplexer. It lets you switch easily between several programs in one terminal, detach them (they keep running in the background) and reattach them to a different terminal. And do a lot more.

Sample Usage

Install tmux and use the provided configuration defaults

class { '::tmux': }

Install tmux to replace GNU/screen

class { '::tmux':
  prefix_key => 'screen'

Uninstall tmux

class { '::tmux':
  ensure => absent,

Class parameters

  • ensure

    • Accepted values: present or absent
    • Default: present
    • Description: Whether or not tmux will be installed
  • auto_update

    • Accepted values: true or false
    • Default: false
    • Description: Whether or not the tmux package should be automatically kept up-to-date using the distribution's packaging system
  • conf_file

    • Accepted values: string
    • Default: /etc/tmux.conf
    • Description: Path to tmux's main configuration file.
  • prefix_key

    • Accepted values: string or 'default' (CTRL+b) or 'screen' (CTRL+a)
    • Default: C-b
    • Description: Sets the prefix key you use to access tmux during a session.
  • vi_mode_keys

    • Accepted values: true or false
    • Default: true
    • Description: Use vi mode keys for scrollbar, etc.
  • pretty_statusbar

    • Accepted values: true or false
    • Default: true
    • Description: Adds a pretty statusbar to your session.
  • clock

    • Accepted valued: true or false
    • Default: true
    • Description: Adds a clock to the status bar
  • default_shell

    • Accepted values: string or default
    • Default: undefined
    • Description: Optionally specify a default shell.