2015-02-20 12:38:09 +00:00
|
|
|
# tmux-continuum
|
2015-02-12 02:32:20 +00:00
|
|
|
|
2015-02-17 16:13:21 +00:00
|
|
|
Features:
|
|
|
|
|
|
|
|
|
|
- continuous saving of tmux environment
|
2015-02-20 01:59:15 +00:00
|
|
|
- automatic tmux start when computer/server is turned on
|
2015-02-17 16:13:21 +00:00
|
|
|
- automatic restore when tmux is started
|
|
|
|
|
|
2015-02-20 01:59:15 +00:00
|
|
|
Together these features enable uninterrupted tmux usage. No matter the computer
|
|
|
|
|
or server restarts, if the machine is on, tmux will be there how you left it off
|
|
|
|
|
the last time it was used.
|
2015-02-15 21:34:12 +00:00
|
|
|
|
2015-10-08 16:46:50 +00:00
|
|
|
Tested and working on Linux, OSX and Cygwin.
|
|
|
|
|
|
2015-02-15 21:34:12 +00:00
|
|
|
#### Continuous saving
|
2015-02-12 02:32:20 +00:00
|
|
|
|
2015-02-17 16:13:21 +00:00
|
|
|
Tmux environment will be saved at the interval of 15 minutes. All the saving
|
|
|
|
|
happens in the background without the impact to your workflow.
|
|
|
|
|
|
|
|
|
|
This action starts automatically when the plugin is installed.
|
|
|
|
|
|
|
|
|
|
#### Automatic tmux start
|
|
|
|
|
|
|
|
|
|
Tmux is automatically started after the computer/server is turned on.
|
|
|
|
|
|
2015-10-08 16:44:32 +00:00
|
|
|
See the [instructions](docs/automatic_start.md) how to enable this for your
|
|
|
|
|
system.
|
2015-02-12 02:32:20 +00:00
|
|
|
|
2015-02-15 21:34:12 +00:00
|
|
|
#### Automatic restore
|
|
|
|
|
|
2015-02-17 16:13:21 +00:00
|
|
|
Last saved environment is automatically restored when tmux is started.
|
|
|
|
|
|
2017-09-29 09:43:24 +00:00
|
|
|
Put `set -g @continuum-restore 'on'` in `.tmux.conf` to enable this.
|
2015-02-15 21:34:12 +00:00
|
|
|
|
|
|
|
|
Note: automatic restore happens **exclusively** on tmux server start. No other
|
2017-09-29 09:43:24 +00:00
|
|
|
action (e.g. sourcing `.tmux.conf`) triggers this.
|
2015-02-15 21:34:12 +00:00
|
|
|
|
|
|
|
|
#### Dependencies
|
|
|
|
|
|
|
|
|
|
`tmux 1.9` or higher, `bash`,
|
2015-02-12 02:32:20 +00:00
|
|
|
[tmux-resurrect](https://github.com/tmux-plugins/tmux-resurrect) plugin.
|
|
|
|
|
|
|
|
|
|
### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
|
|
|
|
|
|
2015-10-08 16:38:27 +00:00
|
|
|
Please make sure you have
|
|
|
|
|
[tmux-resurrect](https://github.com/tmux-plugins/tmux-resurrect) installed.
|
2015-02-12 02:32:20 +00:00
|
|
|
|
|
|
|
|
Add plugin to the list of TPM plugins in `.tmux.conf`:
|
|
|
|
|
|
2015-08-10 18:35:34 +00:00
|
|
|
set -g @plugin 'tmux-plugins/tmux-resurrect'
|
|
|
|
|
set -g @plugin 'tmux-plugins/tmux-continuum'
|
2015-02-12 02:32:20 +00:00
|
|
|
|
|
|
|
|
Hit `prefix + I` to fetch the plugin and source it. The plugin will
|
|
|
|
|
automatically start "working" in the background, no action required.
|
|
|
|
|
|
|
|
|
|
### Manual Installation
|
|
|
|
|
|
2015-10-08 16:38:27 +00:00
|
|
|
Please make sure you have
|
|
|
|
|
[tmux-resurrect](https://github.com/tmux-plugins/tmux-resurrect) installed.
|
2015-02-12 02:32:20 +00:00
|
|
|
|
|
|
|
|
Clone the repo:
|
|
|
|
|
|
2015-02-20 12:38:09 +00:00
|
|
|
$ git clone https://github.com/tmux-plugins/tmux-continuum ~/clone/path
|
2015-02-12 02:32:20 +00:00
|
|
|
|
|
|
|
|
Add this line to the bottom of `.tmux.conf`:
|
|
|
|
|
|
2015-02-20 12:38:09 +00:00
|
|
|
run-shell ~/clone/path/continuum.tmux
|
2015-02-12 02:32:20 +00:00
|
|
|
|
2015-10-08 16:38:27 +00:00
|
|
|
Reload TMUX environment with: `$ tmux source-file ~/.tmux.conf`
|
2015-02-12 02:32:20 +00:00
|
|
|
|
|
|
|
|
The plugin will automatically start "working" in the background, no action
|
|
|
|
|
required.
|
|
|
|
|
|
2015-10-08 16:38:27 +00:00
|
|
|
### Docs
|
2015-02-20 01:59:15 +00:00
|
|
|
|
2015-10-08 16:38:27 +00:00
|
|
|
- [frequently asked questions](docs/faq.md)
|
2015-10-08 16:40:24 +00:00
|
|
|
- [behavior when running multiple tmux servers](docs/multiple_tmux_servers.md) -
|
2015-10-08 16:38:27 +00:00
|
|
|
this doc is safe to skip, but you might want to read it if you're using tmux
|
|
|
|
|
with `-L` or `-S` flags
|
2015-10-08 16:44:32 +00:00
|
|
|
- [automatically start tmux after the computer is turned on](docs/automatic_start.md)
|
2015-11-29 17:28:51 +00:00
|
|
|
- [continuum status in tmux status line](docs/continuum_status.md)
|
2015-02-20 01:59:15 +00:00
|
|
|
|
2015-02-12 02:32:20 +00:00
|
|
|
### Other goodies
|
|
|
|
|
|
|
|
|
|
- [tmux-copycat](https://github.com/tmux-plugins/tmux-copycat) - a plugin for
|
|
|
|
|
regex searches in tmux and fast match selection
|
|
|
|
|
- [tmux-yank](https://github.com/tmux-plugins/tmux-yank) - enables copying
|
|
|
|
|
highlighted text to system clipboard
|
|
|
|
|
- [tmux-open](https://github.com/tmux-plugins/tmux-open) - a plugin for quickly
|
|
|
|
|
opening highlighted file or a url
|
|
|
|
|
|
2015-02-20 13:15:43 +00:00
|
|
|
You might want to follow [@brunosutic](https://twitter.com/brunosutic) on
|
|
|
|
|
twitter if you want to hear about new tmux plugins or feature updates.
|
|
|
|
|
|
2015-02-12 02:32:20 +00:00
|
|
|
### Reporting bugs and contributing
|
|
|
|
|
|
|
|
|
|
Both contributing and bug reports are welcome. Please check out
|
|
|
|
|
[contributing guidelines](CONTRIBUTING.md).
|
|
|
|
|
|
|
|
|
|
### License
|
|
|
|
|
[MIT](LICENSE.md)
|
