Read and change options

Pass a native server, session, window or pane to select its option table. Use -Scope to override the table and -Global for that scope’s global defaults. For example, a server handle with -Scope Session -Global addresses global session defaults. Choose the endpoint explicitly with fNew-TmuxServer.

Read the effective key mode from a previously selected $session:

$session | Get-TmuxOption -Name 'status-keys' -IncludeInherited

Each result is a native STmuxOption. Its pName, pIndex, pInherited and pValue describe what tmux reported. Omit -Name to list a table. A normal read lists local values; -IncludeInherited adds inherited values. -Quiet makes a missing option produce no rows. Where-Object filters returned rows locally.

Store a user option and return the value tmux actually stored:

$session | Set-TmuxOption -Name '@project' -Value 'api' -PassThru

-PassThru emits a native STmuxOptionValue; its pRaw, pBoolean, pInteger and pState fields preserve tmux’s interpretation. Without it, setting emits no success output. -Append and -ExpandFormat return the stored result, not just the supplied argument. -PreventOverwrite asks tmux to refuse replacement and can produce an error.

Remove a previously stored user option:

$session | Remove-TmuxOption -Name '@scratch'

Removing a built-in override restores inheritance. An empty string is a stored value, so setting '' does not remove an option. Indexed names such as command-alias[40] read, set or remove that specific array entry; listing the base name preserves sparse indices. tmux expands formats in option names, so # is not guaranteed literal.

Set and Remove support -WhatIf and -Confirm; previews contact no server. Errors retain the original core exception and owner. -ErrorAction Continue permits later owners; Stop terminates the pipeline. Cancellation cannot undo a dispatched mutation. Readback does not make a mutation atomic with other clients.