https://github.com/hamolicious/back-in-5
Display a "back in 5" message over your tmux session.
https://github.com/hamolicious/back-in-5
bash terminal tmux tmux-plugin
Last synced: 22 days ago
JSON representation
Display a "back in 5" message over your tmux session.
- Host: GitHub
- URL: https://github.com/hamolicious/back-in-5
- Owner: hamolicious
- Created: 2025-04-25T18:18:09.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-04-26T00:11:19.000Z (8 months ago)
- Last Synced: 2025-04-26T01:20:44.423Z (8 months ago)
- Topics: bash, terminal, tmux, tmux-plugin
- Language: Shell
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-tmux - back-in-5
README
# Back in 5
Display a "back in 5" message over your [`tmux`](https://github.com/tmux/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](https://github.com/tmux-plugins/tpm):
```tmux
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](#configuration) for more details on variables_
## Usage
Once installed and [`tmux`](https://github.com/tmux/tmux) enviornment reloaded. Simply use `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.
## 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.
```bash
#!/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
- https://www.asciiart.eu/