Skip to content

hamolicious/back-in-5

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Back in 5

Display a "back in 5" message over your tmux session.

You are sharing your screen, pairing and your partner has to step out for a moment. You decide to use the moment to fetch yourself another coffee.

Now obviously the sensible thing to do here is to message them and let them know you're going to fetch a coffee leave a message on your screen for them to stumble on.

Installation

Add to .tmux.conf with TPM:

set -g @plugin 'hamolicious/back-in-5'
BACK_IN_5_MESSAGE_SH= # override top message
BACK_IN_5_ART_PATH= # override path where art is chosen randomly from
BACK_IN_5_LAUNCH_KEY= # set the key that launches the panel

See Configuration for more details on variables

Usage

Once installed and tmux enviornment reloaded. Simply use <prefix>b.

The dashboard shows the time the command was ran, this is so your partner can guestimate how much longer you will be.

Lastly, a random asciiart animal is attached at the bottom in case your partner gets bored.

terminal-screenshot

Configuration

The message and art can be overriden with the following environment variables. Place these in your .tmux.conf after the plugin definition.

BACK_IN_5_MESSAGE_SH: A path to a bash script echoing the message, see default below which is used if this variable is left unset.

#!/bin/bash
echo ""
echo "β˜• Coffee break"
echo ""
echo "πŸ•” Started at: $(date "+%H:%M")"
echo ""
echo "πŸƒ Back Shortly"

BACK_IN_5_ART_PATH: A path containing any text files, they will be rendered as a "2D block" of text to ensure ascii art is not messed with. Uses the bundled ascii art animals directory curated from https://www.asciiart.eu/ by default.

BACK_IN_5_LAUNCH_KEY: The key used to show the pane, default is "b"

References

About

Display a "back in 5" message over your tmux session.

Topics

Resources

Stars

Watchers

Forks

Languages