Package: libtmux
libtmuxlibtmuxis atypedPython library that provides a wrapper for interacting programmatically with tmux, a terminal multiplexer. You can use it to manage tmux servers,
sessions, windows, and panes. Additionally,libtmuxpowerstmuxp, a tmux workspace manager.libtmux builds upon tmux'stargetandformatsto
create an object mapping to traverse, inspect and interact with live
tmux sessions.View thedocumentation,APIinformation andarchitectural details.Install$pipinstall--userlibtmuxOpen a tmux sessionSession namefoo, window namebar$tmuxnew-session-sfoo-nbarPilot your tmux session via python$pythonUseptpython,ipython, etc. for a nice shell with autocompletions:$pipinstall--userptpython$ptpythonConnect to a live tmux session:>>>importlibtmux>>>svr=libtmux.Server()>>>svrServer(socket_path=/tmp/tmux-.../default)Tip: You can also usetmuxp'stmuxp shellto drop straight into your
current tmux server / session / window pane.Run any tmux command, respective of context:Honors tmux socket name and path:>>>server=Server(socket_name='libtmux_doctest')>>>server.cmd('display-message','hello world')<libtmux...>New session:>>>server.cmd('new-session','-d','-P','-F#{session_id}').stdout[0]'$2'>>>session.cmd('new-window','-P').stdout[0]'libtmux...:2.0'From raw command output, to a richWindowobject (in practice and as shown
later, you'd useSession.new_window()):>>>Window.from_window_id(window_id=session.cmd('new-window','-P','-F#{window_id}').stdout[0],server=session.server)Window(@22:...,Session($1libtmux_...))Create a pane from a window:>>>window.cmd('split-window','-P','-F#{pane_id}').stdout[0]'%2'Raw output directly to aPane:>>>Pane.from_pane_id(pane_id=window.cmd('split-window','-P','-F#{pane_id}').stdout[0],server=window.server)Pane(%...Window(@11:...,Session($1libtmux_...)))List sessions:>>>server.sessions[Session($1...),Session($0...)]Filter sessions by attribute:>>>server.sessions.filter(history_limit='2000')[Session($1...),Session($0...)]Direct lookup:>>>server.sessions.get(session_id="$1")Session($1...)Filter sessions:>>>server.sessions[0].rename_session('foo')Session($1foo)>>>server.sessions.filter(session_name="foo")[Session($1foo)]>>>server.sessions.get(session_name="foo")Session($1foo)Control your session:>>>sessionSession($1...)>>>session.rename_session('my-session')Session($1my-session)Create new window in the background (don't switch to it):>>>bg_window=session.new_window(attach=False,window_name="ha in the bg")>>>bg_windowWindow(@...2:hainthebg,Session($1...))# Session can search the window>>>session.windows.filter(window_name__startswith="ha")[Window(@...2:hainthebg,Session($1...))]# Directly>>>session.windows.get(window_name__startswith="ha")Window(@...2:hainthebg,Session($1...))# Clean up>>>bg_window.kill()Close window:>>>w=session.active_window>>>w.kill()Grab remaining tmux window:>>>window=session.active_window>>>window.split_window(attach=False)Pane(%2Window(@11:...Session($1...)))Rename window:>>>window.rename_window('libtmuxower')Window(@11:libtmuxower,Session($1...))Split window (create a new pane):>>>pane=window.split_window()>>>pane=window.split_window(attach=False)>>>pane.select()Pane(%3Window(@11:...,Session($1...)))>>>window=session.new_window(attach=False,window_name="test")>>>windowWindow(@22:test,Session($1...))>>>pane=window.split_window(attach=False)>>>panePane(%5Window(@22:test,Session($1...)))Type inside the pane (send key strokes):>>>pane.send_keys('echo hey send now')>>>pane.send_keys('echo hey',enter=False)>>>pane.enter()Pane(%1...)Grab the output of pane:>>>pane.clear()# clear the panePane(%1...)>>>pane.send_keys("cowsay 'hello'",enter=True)>>>print('\n'.join(pane.cmd('capture-pane','-p').stdout))# doctest: +SKIP$cowsay'hello'_______<hello>-------\^__^\(oo)\_______(__)\)\/\||----w|||||...Traverse and navigate:>>>pane.windowWindow(@11:...,Session($1...))>>>pane.window.sessionSession($1...)Python supportUnsupported / no security releases or bug fixes:Python 2.x: The backports branch isv0.8.x.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/libtmuxDocs:https://libtmux.git-pull.comAPI:https://libtmux.git-pull.com/api.htmlChangelog:https://libtmux.git-pull.com/history.htmlIssues:https://github.com/tmux-python/libtmux/issuesTest Coverage:https://codecov.io/gh/tmux-python/libtmuxpypi:https://pypi.python.org/pypi/libtmuxOpen Hub:https://www.openhub.net/p/libtmux-pythonRepology:https://repology.org/project/python:libtmux/versionsLicense:MIT.