{"id":16194421,"url":"https://github.com/muniftanjim/tmux-suspend","last_synced_at":"2025-10-11T23:04:57.328Z","repository":{"id":49967780,"uuid":"365169238","full_name":"MunifTanjim/tmux-suspend","owner":"MunifTanjim","description":"Plugin that lets you suspend local tmux session, so that you can work with nested remote tmux session painlessly.","archived":false,"fork":false,"pushed_at":"2023-01-15T05:38:57.000Z","size":376,"stargazers_count":137,"open_issues_count":0,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-16T01:41:18.105Z","etag":null,"topics":["tmux","tmux-plugin","tmux-plugins"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MunifTanjim.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-07T08:40:04.000Z","updated_at":"2025-03-08T12:08:40.000Z","dependencies_parsed_at":"2023-02-09T21:16:00.181Z","dependency_job_id":null,"html_url":"https://github.com/MunifTanjim/tmux-suspend","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MunifTanjim%2Ftmux-suspend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MunifTanjim%2Ftmux-suspend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MunifTanjim%2Ftmux-suspend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MunifTanjim%2Ftmux-suspend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MunifTanjim","download_url":"https://codeload.github.com/MunifTanjim/tmux-suspend/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243858891,"owners_count":20359257,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["tmux","tmux-plugin","tmux-plugins"],"created_at":"2024-10-10T08:19:17.281Z","updated_at":"2025-10-11T23:04:52.284Z","avatar_url":"https://github.com/MunifTanjim.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tmux Suspend\n\nPlugin that lets you suspend **local tmux session**, so that you can work with\n**nested remote tmux session** painlessly.\n\n**Demo**:\n\n![Tmux Suspend Demo GIF](screenshots/tmux-suspend-demo.gif)\n\n## Usage\n\nWith the default keybinding,\n\nPress `F12` to suspend your local tmux session. In suspeded state, you can only\ninteract with the currently active pane (which will be running the remote tmux session).\n\nPress `F12` again in suspended state to resume local tmux session.\n\n_**Note**_: If you have [**tmux-mode-indicator**](https://github.com/MunifTanjim/tmux-mode-indicator)\nplugin installed, it'll automatically show indicator for the suspended state.\n\n## Installation\n\n### Installation with [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm)\n\nAdd this repository as a TPM plugin in your `.tmux.conf` file:\n\n```conf\nset -g @plugin 'MunifTanjim/tmux-suspend'\n```\n\nPress `prefix + I` in Tmux environment to install it.\n\n### Manual Installation\n\nClone this repository:\n\n```bash\ngit clone https://github.com/MunifTanjim/tmux-suspend.git ~/.tmux/plugins/tmux-suspend\n```\n\nAdd this line in your `.tmux.conf` file:\n\n```conf\nrun-shell ~/.tmux/plugins/tmux-suspend/suspend.tmux\n```\n\nReload Tmux configuration file with:\n\n```sh\ntmux source-file ~/.tmux.conf\n```\n\n## Configuration Options\n\nThe following configuration options are available:\n\n### `@suspend_key`\n\nKey used to suspend/resume local tmux session. This is not binded to any Prefix.\n\n```conf\nset -g @suspend_key 'F12'\n```\n\n### `@suspend_suspended_options`\n\nComma-seperated list of items denoting options to set for suspended state.\nThese options will be automatically reverted when session is resumed.\n\n```conf\nset -g @suspend_suspended_options \" \\\n  @mode_indicator_custom_prompt:: ---- , \\\n  @mode_indicator_custom_mode_style::bg=brightblack\\\\,fg=black, \\\n\"\n```\n\nThe syntax of each item is `#{option_name}:#{option_flags}:#{option_value}`.\n\n| Item Segment      | Description                                                                |\n| ----------------- | -------------------------------------------------------------------------- |\n| `#{option_name}`  | name of the option.                                                        |\n| `#{option_flags}` | flags accepted by `set-option`, can be left empty.                         |\n| `#{option_value}` | value of the option, commas (`,`) inside value need to be escaped as `\\\\,` |\n\nFor example:\n\n```conf\n# remove colors from status line for suspended state\nset -g @suspend_suspended_options \" \\\n  status-left-style::bg=brightblack\\\\,fg=black bold dim, \\\n  window-status-current-style:gw:bg=brightblack\\\\,fg=black, \\\n  window-status-last-style:gw:fg=brightblack, \\\n  window-status-style:gw:bg=black\\\\,fg=brightblack, \\\n  @mode_indicator_custom_prompt:: ---- , \\\n  @mode_indicator_custom_mode_style::bg=brightblack\\\\,fg=black, \\\n\"\n```\n\n### `@suspend_on_suspend_command` and `@suspend_on_resume_command`\n\nThese options can be set to arbritary commands to run when session is\nsuspended (`@suspend_on_suspend_command`) or resumed (`@suspend_on_resume_command`).\n\n```conf\nset -g @suspend_on_resume_command \"\"\nset -g @suspend_on_suspend_command \"\"\n```\n\nFor example, you can do the same thing that the default value of `@suspend_suspended_options`\ndoes using these options instead:\n\n```conf\nset -g @suspend_suspended_options \"\"\n\nset -g @suspend_on_resume_command \"tmux \\\n  set-option -uq '@mode_indicator_custom_prompt' \\\\; \\\n  set-option -uq '@mode_indicator_custom_mode_style'\"\n\nset -g @suspend_on_suspend_command \"tmux \\\n  set-option -q '@mode_indicator_custom_prompt' ' ---- ' \\\\; \\\n  set-option -q '@mode_indicator_custom_mode_style' 'bg=brightblack,fg=black'\"\n```\n\nAs you can see, it's more convenient to use `@suspend_suspended_options` for setting\nand reverting options.\n\n## License\n\nLicensed under the MIT License. Check the [LICENSE](./LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuniftanjim%2Ftmux-suspend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmuniftanjim%2Ftmux-suspend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmuniftanjim%2Ftmux-suspend/lists"}