# LibTmux

- **Package:** LibTmux
- **Language:** PowerShell
- **Kind:** module
- **Source:** https://github.com/libtmux/libtmux-powershell/blob/b06c64f844f3173de66b187eaeaf3915814318c6/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. Alpha.

## Members

### Collections and queries

- `Get-TmuxSession` (function): Read sessions with optional exact selectors.
- `Get-TmuxWindow` (function): Read contextual windows from a server or session.
- `Get-TmuxPane` (function): Read panes from a server, session or window.
- `Get-TmuxClient` (function): Read the clients attached to a tmux server.
- `Get-TmuxSnapshot` (function): Capture a replacement tmux hierarchy.

### Common operations

- `New-TmuxServer` (function): Construct a tmux endpoint handle without contacting it.
- `Connect-TmuxServer` (function): Discover the server at an explicit endpoint.
- `Invoke-TmuxPaneCommand` (function): Run a shell command in a native pane and report its exit status.
- `Remove-TmuxSession` (function): Remove an explicit native session without emitting an object.
- `Wait-TmuxPaneText` (function): Wait for rendered text in a native tmux pane.
- `Watch-TmuxEvent` (function): Stream native tmux events with bounded delivery and explicit ownership.
- `Connect-TmuxControl` (function): Attach a native control client to an explicit tmux target.
- `Invoke-TmuxControlCommand` (function): Run a native command on a borrowed control client.
- `New-TmuxCommand` (function): Construct a native tmux command without running it.
- `Disconnect-TmuxControl` (function): Dispose an explicitly supplied tmux control client.
- `Enter-TmuxSession` (function): Attach your foreground terminal to a selected session.
- `Get-TmuxPaneContent` (function): Capture rendered text from a pane.
- `Get-TmuxQueryField` (function): Discover query fields, operators and native bindings.
- `Invoke-TmuxChain` (function): Execute an ordered command chain against one server.
- `New-TmuxSession` (function): Create a detached session on an explicit server.
- `Select-TmuxPane` (function): Filter captured native panes.
- `Select-TmuxSession` (function): Filter captured native sessions.
- `Send-TmuxKey` (function): Send an ordered sequence of tmux key tokens to a native pane.
- `Split-TmuxPane` (function): Split an explicit pane and return the newly created pane.
- `Update-TmuxPane` (function): Refresh a pane into a replacement captured object.
- `ConvertTo-TmuxQueryJson` (function): Serialize a native query document.
- `Get-TmuxQueryPlan` (function): Inspect how a query will run against a known tmux version.
- `Invoke-TmuxCommand` (function): Execute literal tmux arguments against an explicit server.
- `Invoke-TmuxQuery` (function): Acquire fresh tmux objects using an explicit query.
- `New-TmuxQuery` (function): Build reusable criteria for captured tmux objects.
- `New-TmuxWindow` (function): Create a window in an explicit session.
- `Remove-TmuxPane` (function): Remove an explicit native pane without emitting an object.
- `Remove-TmuxWindow` (function): Remove a physical window and all its session links.
- `Select-TmuxWindow` (function): Filter captured native windows.
- `Send-TmuxText` (function): Send literal text and optional Enter to a native pane.
- `Wait-TmuxChannel` (function): Wait for a tmux channel signal with a timeout and owned withdrawal.
- `Get-TmuxClientAttachment` (function): Resolve the session, window and pane a client currently views.
- `Get-TmuxEnvironment` (function): Read native tmux environment entries.
- `Get-TmuxHook` (function): Read native grouped hooks from an owner table.
- `Get-TmuxOption` (function): Read a native tmux option table or named option.
- `Get-TmuxServer` (function): Inspect an existing tmux daemon's identity and version.
- `Invoke-TmuxHook` (function): Run a configured tmux hook now.
- `Move-TmuxWindow` (function): Move one session placement of a window.
- `New-TmuxWindowLink` (function): Link a window into another session.
- `Remove-TmuxEnvironment` (function): Unset an environment entry or keep an explicit removal marker.
- `Remove-TmuxHook` (function): Remove a hook or one indexed entry.
- `Remove-TmuxOption` (function): Unset an option so its inherited value applies.
- `Remove-TmuxWindowLink` (function): Remove one session placement of a window.
- `Set-TmuxEnvironment` (function): Set a tmux environment variable for future processes or formats.
- `Set-TmuxHook` (function): Set a hook entry and optionally return its grouped readback.
- `Set-TmuxLayout` (function): Arrange the panes of a window.
- `Set-TmuxOption` (function): Set an option in a native tmux owner table.
- `Set-TmuxPaneSize` (function): Resize a pane or toggle its zoom.
- `Set-TmuxWindowSize` (function): Resize a window in cells or against its attached clients.
- `Update-TmuxClient` (function): Refresh a client into a replacement captured object.