tmux-resurrect-auto

Continuous saving of tmux environment.

After this plugin is installed, tmux-resurrect will save environment at the interval of 15 minutes. All the saving happens in the background without the impact to your workflow.

Requirements / dependencies: tmux 1.9 or higher, bash, tmux-resurrect plugin.

Installation with Tmux Plugin Manager (recommended)

Please make sure you have tmux-resurrect installed.

Add plugin to the list of TPM plugins in .tmux.conf:

set -g @tpm_plugins '                \
  tmux-plugins/tpm                   \
  tmux-plugins/tmux-resurrect        \
  tmux-plugins/tmux-resurrect-auto   \
'

Hit prefix + I to fetch the plugin and source it. The plugin will automatically start "working" in the background, no action required.

Manual Installation

Please make sure you have tmux-resurrect installed.

Clone the repo:

$ git clone https://github.com/tmux-plugins/tmux-resurrect-auto ~/clone/path

Add this line to the bottom of .tmux.conf:

run-shell ~/clone/path/resurrect_auto.tmux

Reload TMUX environment:

# type this in terminal
$ tmux source-file ~/.tmux.conf

The plugin will automatically start "working" in the background, no action required.

FAQ

Will a previous save be overwritten immediately after I start tmux?

No, first automatic save starts 15 minutes after tmux is started. That gives you enough time to restore from a previous save.

I want to make a restore to a previous point in time, but it seems that save is now overwritten?

None of the previous saves are deleted (unless you explicitly do that). All save files are kept in ~/.tmux/resurrect/ directory.
Here are the steps to restore to a previous point in time:

make sure you start this with a "fresh" tmux instance
$ cd ~/.tmux/resurrect/
locate the save file you'd like to use for restore (file names have a timestamp)
symlink the last file to the desired save file: $ ln -sf <file_name> last
do a restore with prefix + Ctrl-r

You should now be restored to the time when <file_name> save happened.

Will this plugin fill my hard disk?

Most likely no. A regular save file is in the range of 5Kb. That said, it would be good to clean out old save files from ~/.tmux/resurrect/ dir from time to time.

Configuration

set the save interval to 60 minutes (the default is 15, the number is always in minutes)
```
  set -g @resurrect-auto-save-interval '60'
```

Other goodies

tmux-copycat - a plugin for regex searches in tmux and fast match selection
tmux-yank - enables copying highlighted text to system clipboard
tmux-open - a plugin for quickly opening highlighted file or a url

Reporting bugs and contributing

Both contributing and bug reports are welcome. Please check out contributing guidelines.

License

MIT

3.2 KiB Raw Blame History