You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Bruno Sutic 5f5f9d8fd5
Kill session 0 if it's not restored
1 week ago
docs Whitespace cleanup 1 month ago
lib Update tmux-test 3 years ago
save_command_strategies Change `CPID` to something a little less cryptic 7 months ago
scripts Kill session 0 if it's not restored 1 week ago
strategies Don't be too smart when restoring vim session 2 months ago
tests Update tests to save and restore a setup with a zoomed pane. 2 years ago
video Add issue video screenshot 5 years ago
.gitattributes Adding png attributes as binary files so git does not swap the crlf to lf. 4 years ago
.gitignore Run setup task from .travis.yml 5 years ago
.gitmodules Setup 'tmux-test' 5 years ago
.travis.yml Update '.travis.yml' from tmux-test 3 years ago
CHANGELOG.md Kill session 0 if it's not restored 1 week ago
CONTRIBUTING.md Change plugin name and all the variables 6 years ago
LICENSE.md Initial commit 6 years ago
README.md Deprecate restoring shell history 11 months ago
resurrect.tmux Add mosh-client default strategy 1 year ago
run_tests Do not gitignore 'tmux-test' files 5 years ago

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

  • prefix + Ctrl-s - save
  • prefix + Ctrl-r - restore

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:

  • all sessions, windows, panes and their order
  • current working directory for each pane
  • exact pane layouts within windows (even when zoomed)
  • active and alternative session
  • active and alternative window for each session
  • windows with focus
  • active pane for each window
  • “grouped sessions” (useful feature when using tmux with multiple monitors)
  • programs running within a pane! More details in the restoring programs doc.

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

Experimental features (also optional)

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
  • tmux-continuum - automatic restoring and continuous saving of tmux env

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