resurrect.wezterm
A Wezterm plugin to save and restore terminal windows, tabs, and panes with their layout and text, inspired by tmux-resurrect.
What is resurrect.wezterm?
Resurrect.wezterm is a plugin for the Wezterm terminal emulator that saves and restores terminal session state, including windows, tabs, panes, layout, and shell output. It solves the problem of losing complex terminal setups when closing the terminal or rebooting, providing persistent workspaces akin to tmux-resurrect but for Wezterm.
Wezterm users who manage multiple projects, remote sessions, or complex terminal layouts and want to preserve their workspace state across sessions.
Developers choose Resurrect.wezterm for its deep integration with Wezterm, support for remote domains, optional encryption, and flexible restoration options, offering a seamless session persistence solution without leaving the Wezterm ecosystem.
Overview
A plugin to restore windows, tabs and panes for Wezterm inspired by tmux-resurrect
Use Cases
Best For
- Restoring terminal sessions after system reboots or accidental closures
- Managing multiple projects with dedicated terminal workspaces
- Preserving SSH, Docker, or WSL session states across disconnections
- Automatically saving terminal state at regular intervals
- Securing terminal session data with client-side encryption
- Quickly switching between saved terminal layouts using fuzzy search
Not Ideal For
- Users who do not use Wezterm as their terminal emulator
- Teams seeking a terminal with built-in session persistence without plugin configuration
- Environments where terminal performance is critical and session save/restore overhead is unacceptable
- Windows users requiring reliable encryption due to stdin limitations on the platform
Pros & Cons
Pros
Saves and restores windows, tabs, panes, layout, and shell output as JSON files, enabling exact workspace recovery as demonstrated in the state file example.
Automatically re-attaches to SSH, WSL, Docker, and other remote sessions, maintaining connection states without manual re-login, per the features list.
Offers optional encryption using age, rage, or GnuPG with configurable setup, including custom encrypt/decrypt functions for enhanced security, detailed in the encryption section.
Integrates seamlessly with other Wezterm plugins like smart_workspace_switcher and emits events for custom hooks, shown in usage and event system examples.
Cons
Requires non-trivial Lua coding for keybinds, encryption setup, and plugin integration, as seen in the lengthy setup examples and custom callback functions.
Saving large shell outputs can slow down operations, necessitating manual line limits via `set_max_nlines` to mitigate, indicating inherent scalability issues.
Windows users face encryption errors due to stdin constraints and must manage directory write access manually, as warned in the README's platform notes.
Frequently Asked Questions
Related Projects
smart_workspace_switcher.weztermA smart wezterm workspace switcher plugin inspired by joshmedeski/t-smart-tmux-session-manager
sessionizer.weztermA sessionizer for wezterm
quick_domains.weztermQuckly search and attach to wezterm domains with a click of a keybind
wezterm-sessionsA WezTerm sessions manager plugin
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.