# API reference

Source: https://libtmux.org/en/powershell/latest/reference/

> Types, methods, and functions in libtmux for PowerShell.

Browse the LibTmux cmdlets by the tmux objects and operations they control. Each command includes syntax, parameter sets, pipeline types, and examples.

Server 3 cmdlets

[New-TmuxServer](https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxserver/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Construct a tmux endpoint handle without contacting it.

[Get-TmuxServer](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxserver/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Inspect an existing tmux daemon's identity and version.

[Connect-TmuxServer](https://libtmux.org/en/powershell/latest/reference/libtmux-connect-tmuxserver/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Discover the server at an explicit endpoint.

Session 5 cmdlets

[Get-TmuxSession](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxsession/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Read sessions with optional exact selectors.

[Select-TmuxSession](https://libtmux.org/en/powershell/latest/reference/libtmux-select-tmuxsession/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Filter` ](https://libtmux.org/en/csharp/latest/reference/libtmux-listbuffersrequest-filter/)captured native sessions.

[New-TmuxSession](https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxsession/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Create` ](https://libtmux.org/en/csharp/latest/reference/libtmux-tmuxcommand-create/)a detached session on an explicit server.

[Enter-TmuxSession](https://libtmux.org/en/powershell/latest/reference/libtmux-enter-tmuxsession/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Attach your foreground terminal to a selected session.

[Remove-TmuxSession](https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxsession/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Remove an explicit native session without emitting an object.

Window 8 cmdlets

[Get-TmuxWindow](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxwindow/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Read contextual windows from a server or session.

[Select-TmuxWindow](https://libtmux.org/en/powershell/latest/reference/libtmux-select-tmuxwindow/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Filter` ](https://libtmux.org/en/csharp/latest/reference/libtmux-listbuffersrequest-filter/)captured native windows.

[New-TmuxWindow](https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxwindow/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Create` ](https://libtmux.org/en/csharp/latest/reference/libtmux-tmuxcommand-create/)a window in an explicit session.

[New-TmuxWindowLink](https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxwindowlink/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Link a window into another session.

[Set-TmuxWindowSize](https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxwindowsize/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Resize a window in cells or against its attached clients.

[Move-TmuxWindow](https://libtmux.org/en/powershell/latest/reference/libtmux-move-tmuxwindow/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Move one session placement of a window.

[Remove-TmuxWindowLink](https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxwindowlink/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Remove one session placement of a window.

[Remove-TmuxWindow](https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxwindow/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Remove a physical window and all its session links.

Pane 10 cmdlets

[Get-TmuxPane](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxpane/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Read panes from a server, session or window.

[Select-TmuxPane](https://libtmux.org/en/powershell/latest/reference/libtmux-select-tmuxpane/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Filter` ](https://libtmux.org/en/csharp/latest/reference/libtmux-listbuffersrequest-filter/)captured native panes.

[Get-TmuxPaneContent](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxpanecontent/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Capture rendered text from a pane.

[Split-TmuxPane](https://libtmux.org/en/powershell/latest/reference/libtmux-split-tmuxpane/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Split an explicit pane and return the newly created pane.

[Send-TmuxText](https://libtmux.org/en/powershell/latest/reference/libtmux-send-tmuxtext/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Send literal text and optional [`Enter` ](https://libtmux.org/en/csharp/latest/reference/libtmux-sendkeysrequest-enter/)to a native pane.

[Invoke-TmuxPaneCommand](https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxpanecommand/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Run a shell command in a native pane and report its exit status.

[Wait-TmuxPaneText](https://libtmux.org/en/powershell/latest/reference/libtmux-wait-tmuxpanetext/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Wait` ](https://libtmux.org/en/csharp/latest/reference/libtmux-tmuxwaitmode-wait/)for rendered text in a native tmux pane.

[Update-TmuxPane](https://libtmux.org/en/powershell/latest/reference/libtmux-update-tmuxpane/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Refresh a pane into a replacement captured object.

[Set-TmuxPaneSize](https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxpanesize/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Resize a pane or toggle its zoom.

[Remove-TmuxPane](https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxpane/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Remove an explicit native pane without emitting an object.

Client 3 cmdlets

[Get-TmuxClient](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxclient/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Read the clients attached to a tmux server.

[Get-TmuxClientAttachment](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxclientattachment/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Resolve the session, window and pane a client currently views.

[Update-TmuxClient](https://libtmux.org/en/powershell/latest/reference/libtmux-update-tmuxclient/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Refresh a client into a replacement captured object.

Hooks 4 cmdlets

[Get-TmuxHook](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxhook/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Read native grouped hooks from an owner table.

[Set-TmuxHook](https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxhook/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Set a hook entry and optionally return its grouped readback.

[Invoke-TmuxHook](https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxhook/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Run a configured tmux hook now.

[Remove-TmuxHook](https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxhook/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Remove a hook or one indexed entry.

Options — Functions 3 cmdlets

[Get-TmuxOption](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxoption/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Read a native tmux option table or named option.

[Set-TmuxOption](https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxoption/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Set an option in a native tmux owner table.

[Remove-TmuxOption](https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxoption/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Unset` ](https://libtmux.org/en/csharp/latest/reference/libtmux-sethookrequest-unset/)an option so its inherited value applies.

Keys and bindings 1 cmdlets

[Send-TmuxKey](https://libtmux.org/en/powershell/latest/reference/libtmux-send-tmuxkey/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Send an ordered sequence of tmux key tokens to a native pane.

Layout and geometry 1 cmdlets

[Set-TmuxLayout](https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxlayout/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Arrange the panes of a window.

Environment 3 cmdlets

[Get-TmuxEnvironment](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxenvironment/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Read native tmux environment entries.

[Set-TmuxEnvironment](https://libtmux.org/en/powershell/latest/reference/libtmux-set-tmuxenvironment/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Set a tmux environment variable for future processes or formats.

[Remove-TmuxEnvironment](https://libtmux.org/en/powershell/latest/reference/libtmux-remove-tmuxenvironment/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Unset` ](https://libtmux.org/en/csharp/latest/reference/libtmux-sethookrequest-unset/)an environment entry or keep an explicit removal marker.

Commands 3 cmdlets

[New-TmuxCommand](https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxcommand/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Construct a native tmux command without running it.

[Invoke-TmuxCommand](https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxcommand/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Execute literal tmux arguments against an explicit server.

[Invoke-TmuxChain](https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxchain/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Execute an ordered command chain against one server.

Control mode 5 cmdlets

[Connect-TmuxControl](https://libtmux.org/en/powershell/latest/reference/libtmux-connect-tmuxcontrol/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Attach a native control client to an explicit tmux target.

[Watch-TmuxEvent](https://libtmux.org/en/powershell/latest/reference/libtmux-watch-tmuxevent/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Stream native tmux events with bounded delivery and explicit ownership.

[Wait-TmuxChannel](https://libtmux.org/en/powershell/latest/reference/libtmux-wait-tmuxchannel/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Wait` ](https://libtmux.org/en/csharp/latest/reference/libtmux-tmuxwaitmode-wait/)for a tmux channel signal with a timeout and owned withdrawal.

[Invoke-TmuxControlCommand](https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxcontrolcommand/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Run a native command on a borrowed control client.

[Disconnect-TmuxControl](https://libtmux.org/en/powershell/latest/reference/libtmux-disconnect-tmuxcontrol/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Dispose an explicitly supplied tmux control client.

Queries 4 cmdlets

[New-TmuxQuery](https://libtmux.org/en/powershell/latest/reference/libtmux-new-tmuxquery/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Build reusable criteria for captured tmux objects.

[Get-TmuxQueryPlan](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxqueryplan/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Inspect how a query will run against a known tmux version.

[Invoke-TmuxQuery](https://libtmux.org/en/powershell/latest/reference/libtmux-invoke-tmuxquery/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Acquire fresh tmux objects using an explicit query.

[ConvertTo-TmuxQueryJson](https://libtmux.org/en/powershell/latest/reference/libtmux-convertto-tmuxqueryjson/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

[`Serialize` ](https://libtmux.org/en/csharp/latest/reference/libtmux-query-json-queryjson-serialize/)a native query document.

Queries — Fields 1 cmdlets

[Get-TmuxQueryField](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxqueryfield/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Discover query fields, operators and native bindings.

Snapshots 1 cmdlets

[Get-TmuxSnapshot](https://libtmux.org/en/powershell/latest/reference/libtmux-get-tmuxsnapshot/) [cmdlet](https://libtmux.org/en/powershell/latest/reference/glossary/#cmdlet)

Capture a replacement tmux hierarchy.

Other 1 type

[LibTmux](https://libtmux.org/en/powershell/latest/reference/libtmux/) [module](https://libtmux.org/en/powershell/latest/reference/glossary/#module) 55 members

Native PowerShell automation over the [`LibTmux` ](https://libtmux.org/en/powershell/latest/reference/libtmux/).NET core. Alpha.