Package: tmuxp
tmuxpSession manager for tmux, which allows users to save and load tmux sessions through simple configuration files. Powered bylibtmux.New to tmux?The Tao of tmuxis available on Leanpub andAmazon Kindle.
Read and browse the book for freeon the
web.Have some spare time?Help us triage and code review and the tracker. Seeissue
#290!Installationpip:$pipinstall--usertmuxpHomebrew:$brewinstalltmuxpDebian / ubuntu:$sudoaptinstalltmuxpNix:$[[-z$(whichtmux)]]&&(nix-env-itmux&&nix-env-itmuxp)||nix-env-itmuxpFind the package for your distro on repology:https://repology.org/project/tmuxp/versionsDevelopmental releases:pip:$pipinstall--user--upgrade--pretmuxppipx:$pipxinstall--suffix=@next'tmuxp'--pip-args'\--pre'--forceThen usetmuxp@next load [session].Load a tmux sessionLoad tmux sessions via json and YAML,tmuxinatorandteamocilstyle.session_name:4-pane-splitwindows:-window_name:dev windowlayout:tiledshell_command_before:-cd ~/# run as a first command in all panespanes:-shell_command:# pane no. 1-cd /var/log# run multiple commands in this pane-ls -al | grep \.log-echo second pane# pane no. 2-echo third pane# pane no. 3-echo forth pane# pane no. 4Save asmysession.yaml, and load:$tmuxpload./mysession.yamlProjects with.tmuxp.yamlor.tmuxp.jsonload via directory:$tmuxploadpath/to/my/project/Load multiple at once (in bg, offer to attach last):$tmuxploadmysession./another/project/Name a session:$tmuxpload-ssession_name./mysession.yamlsimpleandvery
elaborateconfig examplesUser-level configurationstmuxp checks for configs in user directories:$TMUXP_CONFIGDIR, if set$XDG_CONFIG_HOME, usually$HOME/.config/tmuxp/$HOME/.tmuxp/Load your tmuxp config from anywhere by using the filename, assuming~/.config/tmuxp/mysession.yaml(or.json):$tmuxploadmysessionSeeauthor's tmuxp configsand
the projects'tmuxp.yaml.ShellNew in 1.6.0:tmuxp shelllaunches into a python console preloaded with the attached
server, session, and window inlibtmuxobjects.$tmuxpshell(Pdb)server<libtmux.server.Server object at 0x7f7dc8e69d10>(Pdb)server.sessions[Session($1 your_project)](Pdb)sessionSession($1 your_project)(Pdb)session.name'your_project'(Pdb)windowWindow(@3 1:your_window, Session($1 your_project))(Pdb)window.name'your_window'(Pdb)window.panes[Pane(%6 Window(@3 1:your_window, Session($1 your_project)))(Pdb)panePane(%6 Window(@3 1:your_window, Session($1 your_project))SupportsPEP
553breakpoint()(includingPYTHONBREAKPOINT). Also supports direct commands via-c:$tmuxpshell-c'print(window.name)'my_window$tmuxpshell-c'print(window.name.upper())'MY_WINDOWRead more ontmuxp shellin
the CLI docs.Pre-load hookRun custom startup scripts (such as installing project dependencies
before loading tmux. See thebootstrap_env.pyandbefore_scriptexampleLoad in detached stateYou can also load sessions in the background by passing-dflagScreenshotFreeze a tmux sessionSnapshot your tmux layout, pane paths, and window/session names.$tmuxpfreezesession-nameSee more aboutfreezing
tmuxsessions.Convert a session fileConvert a session file from yaml to json and vice versa.$tmuxpconvertfilenameThis will prompt you for confirmation and shows you the new file that is
going to be written.You can auto confirm the prompt. In this case no preview will be shown.$tmuxpconvert-yfilename$tmuxpconvert--yesfilenamePlugin Systemtmuxp has a plugin system to allow for custom behavior. See more about
thePlugin System.Debugging HelpersTheloadcommand provides a way to log output to a log file for
debugging purposes.$tmuxpload--log-file<log-file-name>.Collect system info to submit with a Github issue:$tmuxpdebug-info------------------environment:system: Linuxarch: x86_64#...soonDocs / Reading materialSee theQuickstart.Documentationhomepage (also in中文)Want to learn more about tmux itself?Read The Tao of Tmux
online.DonationsYour donations fund development of new features, testing and support.
Your money will go directly to maintenance and development of the
project. If you are an individual, feel free to give whatever feels
right for the value you get out of the project.See donation options athttps://git-pull.com/support.html.Project detailstmux support: 1.8+python support: >= 3.8, pypy, pypy3Source:https://github.com/tmux-python/tmuxpDocs:https://tmuxp.git-pull.comAPI:https://tmuxp.git-pull.com/api.htmlChangelog:https://tmuxp.git-pull.com/history.htmlIssues:https://github.com/tmux-python/tmuxp/issuesTest Coverage:https://codecov.io/gh/tmux-python/tmuxppypi:https://pypi.python.org/pypi/tmuxpOpen Hub:https://www.openhub.net/p/tmuxp-pythonRepology:https://repology.org/project/tmuxp/versionsLicense:MIT.