tmux-resurrect README

The project's README from github.com/tmux-plugins/tmux-resurrect. As one markdown file: README.md.

Tmux Resurrect

Build Status

Restore tmux environment after system restart.

Tmux is great, except when you have to restart the computer. You lose all the running programs, working directories, pane layouts etc. There are helpful management tools out there, but they require initial configuration and continuous updates as your workflow evolves or you start new projects.

tmux-resurrect saves all the little details from your tmux environment so it can be completely restored after a system restart (or when you feel like it). No configuration is required. You should feel like you never quit tmux.

It even (optionally) restores vim and neovim sessions!

Automatic restoring and continuous saving of tmux env is also possible with tmux-continuum plugin.

Screencast

screencast screenshot

Key bindings

About

This plugin goes to great lengths to save and restore all the details from your tmux environment. Here's what's been taken care of:

Optional:

Requirements / dependencies: tmux 1.9 or higher, bash.

Tested and working on Linux, OSX and Cygwin.

tmux-resurrect is idempotent! It will not try to restore panes or windows that already exist.
The single exception to this is when tmux is started with only 1 pane in order to restore previous tmux env. Only in this case will this single pane be overwritten.

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

set -g @plugin 'tmux-plugins/tmux-resurrect'

Hit prefix + I to fetch the plugin and source it. You should now be able to use the plugin.

Manual Installation

Clone the repo:

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

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

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

Reload TMUX environment with: $ tmux source-file ~/.tmux.conf. You should now be able to use the plugin.

Docs

Configuration

Optional features

Other goodies

Reporting bugs and contributing

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

Credits

Mislav Marohnić - the idea for the plugin came from his tmux-session script.

License

MIT

tmux-resurrect (tmux-plugins/tmux-resurrect)

Searching Database…

What is this?A tmux plugin that saves your entire tmux environment (sessions, windows, panes, layouts, running programs) and restores it after a system restart.
Is this a standalone app or a tmux plugin?It's a tmux plugin (shell scripts) that hooks into your tmux config, not a separate application.
How do I install and use it?Add 'set -g @plugin tmux-plugins/tmux-resurrect' to .tmux.conf and hit prefix + I via Tmux Plugin Manager, or manually clone the repo and add 'run-shell ~/clone/path/resurrect.tmux' to .tmux.conf. Then use prefix + Ctrl-s to save and prefix + Ctrl-r to restore.
What do I need to run it?Just tmux 1.9 or higher and bash; no extra configuration is required out of the box.
Does it restore every running program automatically?No, only a conservative default list of programs (vi, vim, nvim, emacs, man, less, more, tail, top, htop, irssi, weechat, mutt) is restored; other programs need extra config per the restoring programs docs.
Does it work on Mac and Windows too, or just Linux?It's tested and working on Linux, macOS (OSX) and Cygwin.
Will it mess up panes I already have open?No, it's idempotent and won't overwrite existing panes or windows, except for the single starting pane when tmux is launched fresh to restore a saved environment.
Can it bring back my vim sessions too?Yes, restoring vim and neovim sessions is an optional feature it supports.
Does it keep saving automatically or do I have to save manually?By itself you save and restore manually with key bindings, but pairing it with the tmux-continuum plugin adds automatic continuous saving and restoring.
What exactly gets restored?Sessions, windows, panes, their order, working directories, exact pane layouts (even zoomed), active/alternative sessions and windows, window focus, grouped sessions, and even the programs running in each pane.
Size
0.6 MB
Stars
13.1K
Updated
CommitMar 06
Age
12y
Commits · 90 Days