Function reference

Create and destroy

attach_pane()

Attach to an existing tmux pane

attach_session()

Attach to an existing tmux session

attach_window()

Attach to an existing tmux window

kill_pane()

Kill a tmux pane

kill_server()

Kill the tmux server

kill_session()

Kill a tmux session

kill_window()

Kill a tmux window

new_pane() split_window()

Create a new tmux pane

new_session()

Create a new tmux session

new_window()

Create a new tmux window

start_server()

Start the tmux server

Inspect

id()

Identifier of a tmux object

index()

Index of a tmux object

is_active()

Is tmux object active?

is_installed()

Is tmux installed correctly?

is_running()

Is the tmux server running?

list_panes()

List tmux panes

list_sessions()

List tmux sessions

list_windows()

List tmux windows

Navigate

select_pane() select_pane_active() select_pane_last() select_pane_next() select_pane_previous() select_pane_top() select_pane_bottom() select_pane_left() select_pane_right() select_pane_top_left() select_pane_top_right() select_pane_bottom_left() select_pane_bottom_right() select_pane_up_of() select_pane_down_of() select_pane_left_of() select_pane_right_of()

Select a tmux pane

select_window() select_window_active() select_window_last() select_window_next() select_window_previous() select_window_start() select_window_end()

Select a tmux window

Layout and style

layout() `layout<-`() set_layout() layout_even_horizontal() layout_even_vertical() layout_main_horizontal() layout_main_vertical() layout_tiled() layout_next() layout_previous() layout_even() layout_undo() layout_rotate()

Change layout of a tmux window

name() `name<-`() set_name()

Name of a tmux object

width() `width<-`() set_width() height() `height<-`() set_height()

Width and height of a tmux object

rename_session()

Rename a tmux session

rename_window()

Rename a tmux window

resize_pane()

Resize a tmux pane

resize_window()

Resize a tmux window

style() `style<-`() set_style()

Style of a tmux window or pane

swap_pane() swap_window()

Swap two tmux windows or panes

Interact

capture_pane()

Capture the contents of a tmux pane

pipe_pane()

Pipe contents of a tmux pane to a shell command

send_keys()

Send keys to a tmux pane

send_prefix()

Send prefix to a tmux pane

Helpers

display_message()

Display a message

prop()

Properties of a tmux object

set_option()

Set option

strfstyle() strpstyle()

Format and parse style strings

tmux_command()

Execute a tmux command

tmux_version()

Get tmux version

Miscellaneous

clock_mode()

Display a large clock