# LibTmux

- **Package:** LibTmux
- **Language:** PowerShell
- **Kind:** module
- **Source:** https://github.com/libtmux/libtmux-powershell/blob/06233d3c99b40a5bce966c9e1d358f346ff4de55/module/LibTmux/LibTmux.psd1#L1
- **Page:** https://libtmux.org/en/powershell/latest/reference/libtmux/

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

## Members

### Collections and queries

- [`Get-TmuxSession`](/en/powershell/latest/reference/libtmux-get-tmuxsession/) (function): Read sessions with optional exact selectors.
- [`Get-TmuxWindow`](/en/powershell/latest/reference/libtmux-get-tmuxwindow/) (function): Read contextual windows from a server or session.
- [`Get-TmuxPane`](/en/powershell/latest/reference/libtmux-get-tmuxpane/) (function): Read panes from a server, session or window.
- [`Get-TmuxClient`](/en/powershell/latest/reference/libtmux-get-tmuxclient/) (function): Read the clients attached to a tmux server.
- [`Get-TmuxSnapshot`](/en/powershell/latest/reference/libtmux-get-tmuxsnapshot/) (function): Capture a replacement tmux hierarchy.

### Common operations

- [`New-TmuxServer`](/en/powershell/latest/reference/libtmux-new-tmuxserver/) (function): Construct a tmux endpoint handle without contacting it.
- [`Connect-TmuxControl`](/en/powershell/latest/reference/libtmux-connect-tmuxcontrol/) (function): Attach a native control client to an explicit tmux target.
- [`Invoke-TmuxPaneCommand`](/en/powershell/latest/reference/libtmux-invoke-tmuxpanecommand/) (function): Run a shell command in a native pane and report its exit status.
- [`Remove-TmuxSession`](/en/powershell/latest/reference/libtmux-remove-tmuxsession/) (function): Remove an explicit native session without emitting an object.
- [`Wait-TmuxPaneText`](/en/powershell/latest/reference/libtmux-wait-tmuxpanetext/) (function): Wait for rendered text in a native tmux pane.
- [`Watch-TmuxEvent`](/en/powershell/latest/reference/libtmux-watch-tmuxevent/) (function): Stream native tmux events with bounded delivery and explicit ownership.
- [`Connect-TmuxServer`](/en/powershell/latest/reference/libtmux-connect-tmuxserver/) (function): Discover the server at an explicit endpoint.
- [`Invoke-TmuxControlCommand`](/en/powershell/latest/reference/libtmux-invoke-tmuxcontrolcommand/) (function): Run a native command on a borrowed control client.
- [`New-TmuxSession`](/en/powershell/latest/reference/libtmux-new-tmuxsession/) (function): Create a detached session on an explicit server.
- [`Disconnect-TmuxControl`](/en/powershell/latest/reference/libtmux-disconnect-tmuxcontrol/) (function): Dispose an explicitly supplied tmux control client.
- [`Get-TmuxPaneContent`](/en/powershell/latest/reference/libtmux-get-tmuxpanecontent/) (function): Capture rendered text from a pane.
- [`Invoke-TmuxChain`](/en/powershell/latest/reference/libtmux-invoke-tmuxchain/) (function): Execute an ordered command chain against one server.
- [`Invoke-TmuxCommand`](/en/powershell/latest/reference/libtmux-invoke-tmuxcommand/) (function): Execute literal tmux arguments against an explicit server.
- [`New-TmuxCommand`](/en/powershell/latest/reference/libtmux-new-tmuxcommand/) (function): Construct a native tmux command without running it.
- [`Send-TmuxKey`](/en/powershell/latest/reference/libtmux-send-tmuxkey/) (function): Send an ordered sequence of tmux key tokens to a native pane.
- [`Split-TmuxPane`](/en/powershell/latest/reference/libtmux-split-tmuxpane/) (function): Split an explicit pane and return the newly created pane.
- [`Enter-TmuxSession`](/en/powershell/latest/reference/libtmux-enter-tmuxsession/) (function): Attach your foreground terminal to a selected session.
- [`Get-TmuxQueryField`](/en/powershell/latest/reference/libtmux-get-tmuxqueryfield/) (function): Discover query fields, operators and native bindings.
- [`New-TmuxWindow`](/en/powershell/latest/reference/libtmux-new-tmuxwindow/) (function): Create a window in an explicit session.
- [`Select-TmuxPane`](/en/powershell/latest/reference/libtmux-select-tmuxpane/) (function): Filter captured native panes.
- [`Select-TmuxSession`](/en/powershell/latest/reference/libtmux-select-tmuxsession/) (function): Filter captured native sessions.
- [`Select-TmuxWindow`](/en/powershell/latest/reference/libtmux-select-tmuxwindow/) (function): Filter captured native windows.
- [`Send-TmuxText`](/en/powershell/latest/reference/libtmux-send-tmuxtext/) (function): Send literal text and optional Enter to a native pane.
- [`Update-TmuxPane`](/en/powershell/latest/reference/libtmux-update-tmuxpane/) (function): Refresh a pane into a replacement captured object.
- [`Wait-TmuxChannel`](/en/powershell/latest/reference/libtmux-wait-tmuxchannel/) (function): Wait for a tmux channel signal with a timeout and owned withdrawal.
- [`ConvertTo-TmuxQueryJson`](/en/powershell/latest/reference/libtmux-convertto-tmuxqueryjson/) (function): Serialize a native query document.
- [`Get-TmuxQueryPlan`](/en/powershell/latest/reference/libtmux-get-tmuxqueryplan/) (function): Inspect how a query will run against a known tmux version.
- [`Invoke-TmuxHook`](/en/powershell/latest/reference/libtmux-invoke-tmuxhook/) (function): Run a configured tmux hook now.
- [`Invoke-TmuxQuery`](/en/powershell/latest/reference/libtmux-invoke-tmuxquery/) (function): Acquire fresh tmux objects using an explicit query.
- [`New-TmuxQuery`](/en/powershell/latest/reference/libtmux-new-tmuxquery/) (function): Build reusable criteria for captured tmux objects.
- [`Remove-TmuxPane`](/en/powershell/latest/reference/libtmux-remove-tmuxpane/) (function): Remove an explicit native pane without emitting an object.
- [`Remove-TmuxWindow`](/en/powershell/latest/reference/libtmux-remove-tmuxwindow/) (function): Remove a physical window and all its session links.
- [`Set-TmuxLayout`](/en/powershell/latest/reference/libtmux-set-tmuxlayout/) (function): Arrange the panes of a window.
- [`Get-TmuxClientAttachment`](/en/powershell/latest/reference/libtmux-get-tmuxclientattachment/) (function): Resolve the session, window and pane a client currently views.
- [`Get-TmuxEnvironment`](/en/powershell/latest/reference/libtmux-get-tmuxenvironment/) (function): Read native tmux environment entries.
- [`Get-TmuxHook`](/en/powershell/latest/reference/libtmux-get-tmuxhook/) (function): Read native grouped hooks from an owner table.
- [`Get-TmuxOption`](/en/powershell/latest/reference/libtmux-get-tmuxoption/) (function): Read a native tmux option table or named option.
- [`Get-TmuxServer`](/en/powershell/latest/reference/libtmux-get-tmuxserver/) (function): Inspect an existing tmux daemon's identity and version.
- [`Move-TmuxWindow`](/en/powershell/latest/reference/libtmux-move-tmuxwindow/) (function): Move one session placement of a window.
- [`New-TmuxWindowLink`](/en/powershell/latest/reference/libtmux-new-tmuxwindowlink/) (function): Link a window into another session.
- [`Remove-TmuxEnvironment`](/en/powershell/latest/reference/libtmux-remove-tmuxenvironment/) (function): Unset an environment entry or keep an explicit removal marker.
- [`Remove-TmuxHook`](/en/powershell/latest/reference/libtmux-remove-tmuxhook/) (function): Remove a hook or one indexed entry.
- [`Remove-TmuxOption`](/en/powershell/latest/reference/libtmux-remove-tmuxoption/) (function): Unset an option so its inherited value applies.
- [`Remove-TmuxWindowLink`](/en/powershell/latest/reference/libtmux-remove-tmuxwindowlink/) (function): Remove one session placement of a window.
- [`Set-TmuxEnvironment`](/en/powershell/latest/reference/libtmux-set-tmuxenvironment/) (function): Set a tmux environment variable for future processes or formats.
- [`Set-TmuxHook`](/en/powershell/latest/reference/libtmux-set-tmuxhook/) (function): Set a hook entry and optionally return its grouped readback.
- [`Set-TmuxOption`](/en/powershell/latest/reference/libtmux-set-tmuxoption/) (function): Set an option in a native tmux owner table.
- [`Set-TmuxPaneSize`](/en/powershell/latest/reference/libtmux-set-tmuxpanesize/) (function): Resize a pane or toggle its zoom.
- [`Set-TmuxWindowSize`](/en/powershell/latest/reference/libtmux-set-tmuxwindowsize/) (function): Resize a window in cells or against its attached clients.
- [`Update-TmuxClient`](/en/powershell/latest/reference/libtmux-update-tmuxclient/) (function): Refresh a client into a replacement captured object.

## Guides

Pages that discuss `LibTmux`.

### Guides

- [Commands and control clients](/en/powershell/latest/guides/commands/)
- [Filter and query tmux objects](/en/powershell/latest/guides/query/)

### Ports

- [tmux workspace manager, forged in PowerShell.](/en/powershell/latest/workspace/)

### Workspace

- [Workspace guide](/en/powershell/latest/workspace/source-guide/)
