API Reference

• Properties
  • Session
  • Windows
  • Panes
• Servers
  • Server
    • child_id_attribute
    • formatter_prefix
    • __init__()
    • socket_name
    • socket_path
    • config_file
    • colors
    • is_alive()
    • raise_if_dead()
    • cmd()
    • attached_sessions
    • has_session()
    • kill()
    • kill_session()
    • switch_client()
    • attach_session()
    • new_session()
    • sessions
    • windows
    • panes
    • getenv()
    • remove_environment()
    • set_environment()
    • show_environment()
    • unset_environment()
    • kill_server()
    • _list_panes()
    • _update_panes()
    • get_by_id()
    • where()
    • find_where()
    • _list_windows()
    • _update_windows()
    • _sessions
    • _list_sessions()
    • list_sessions()
    • children
• Sessions
  • Session
    • refresh()
    • from_session_id()
    • windows
    • panes
    • cmd()
    • set_option()
    • show_options()
    • show_option()
    • select_window()
    • active_pane
    • active_window
    • attach()
    • kill()
    • switch_client()
    • rename_session()
    • new_window()
    • kill_window()
    • id
    • name
    • attached_pane
    • attached_window
    • attach_session()
    • kill_session()
    • get()
    • get_by_id()
    • where()
    • find_where()
    • _list_windows()
    • _windows
    • list_windows()
    • __init__()
    • children
    • getenv()
    • remove_environment()
    • set_environment()
    • show_environment()
    • unset_environment()
• Windows
  • Window
    • refresh()
    • from_window_id()
    • session
    • panes
    • cmd()
    • select_pane()
    • split()
    • resize()
    • last_pane()
    • select_layout()
    • set_window_option()
    • show_window_options()
    • show_window_option()
    • rename_window()
    • kill()
    • move_window()
    • new_window()
    • select()
    • active_pane
    • id
    • name
    • index
    • height
    • width
    • split_window()
    • attached_pane
    • select_window()
    • kill_window()
    • get()
    • get_by_id()
    • where()
    • find_where()
    • _list_panes()
    • _panes
    • list_panes()
    • __init__()
    • children
• Panes
  • Pane
    • window
    • refresh()
    • from_pane_id()
    • window
    • session
    • cmd()
    • resize()
    • capture_pane()
    • send_keys()
    • display_message()
    • kill()
    • select()
    • select_pane()
    • split()
    • set_width()
    • set_height()
    • enter()
    • clear()
    • reset()
    • id
    • index
    • height
    • width
    • at_top
    • at_bottom
    • at_left
    • at_right
    • split_window()
    • __init__()
    • get()
    • resize_pane()
• Constants
  • ResizeAdjustmentDirection
  • WindowDirection
  • PaneDirection
• Utilities
  • libtmux.common
  • TMUX_MIN_VERSION
  • TMUX_MAX_VERSION
  • EnvironmentMixin
    • __init__()
    • set_environment()
    • unset_environment()
    • remove_environment()
    • show_environment()
    • getenv()
  • tmux_cmd
    • __init__()
  • get_version()
  • has_version()
  • has_gt_version()
  • has_gte_version()
  • has_lte_version()
  • has_lt_version()
  • has_minimum_version()
  • session_check_name()
  • handle_option_error()
  • get_libtmux_version()
• Exceptions
  • libtmux.exc
  • LibTmuxException
  • TmuxSessionExists
  • TmuxCommandNotFound
  • TmuxObjectDoesNotExist
    • __init__()
  • VersionTooLow
  • BadSessionName
    • __init__()
  • OptionError
  • UnknownOption
  • UnknownColorOption
    • __init__()
  • InvalidOption
  • AmbiguousOption
  • WaitTimeout
  • VariableUnpackingError
    • __init__()
  • PaneError
  • PaneNotFound
    • __init__()
  • WindowError
  • MultipleActiveWindows
    • __init__()
  • NoActiveWindow
    • __init__()
  • NoWindowsExist
    • __init__()
  • AdjustmentDirectionRequiresAdjustment
    • __init__()
  • WindowAdjustmentDirectionRequiresAdjustment
  • PaneAdjustmentDirectionRequiresAdjustment
  • RequiresDigitOrPercentage
    • __init__()