Python API

libtmux.Server.confirm_before

Python

Python
Ruby Unavailable
Lua Unavailable
TypeScript Unavailable
Rust Unavailable
Go
Java Unavailable
.NET
C++ Unavailable
Swift Unavailable

Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++ Swift

confirm_before ( self , command : str , prompt : str | None = None , confirm_key : str | None = None , default_yes : bool | None = None , target_client : str | None = None ) → None method [source] ¶ method [source] ¶ confirm_before

Run a command after confirmation via $ tmux confirm-before.

Always uses -b (background) to avoid blocking the command queue. Use send-keys -K -c <client> to provide the confirmation key.

Requires tmux 3.3+ for -b flag support.

Examples

Interactive confirmation requires tmux 3.4+; the wrapper itself works on 3.3+ but the send-keys -K -c <client> round-trip used here is unreliable on 3.3a:

>>> from libtmux.common import has_gte_version
>>> if has_gte_version("3.4"):
...     with control_mode() as ctl:
...         server.confirm_before(
...             'set -g @cf_test yes',
...             target_client=ctl.client_name,
...         )
...         _ = server.cmd('send-keys', '-K', '-c', ctl.client_name, 'y')
...         result = server.cmd('show-options', '-gv', '@cf_test').stdout[0]
... else:
...     result = 'yes'
>>> result
'yes'

Parameters

command ( str ) – Tmux command to run after confirmation.
prompt ( str | None ) – Custom prompt text (-p flag).
confirm_key ( str | None ) – Key to accept as confirmation (-c flag). Default is y. Requires tmux 3.4+.
default_yes ( bool | None ) – Make Enter default to yes (-y flag). Requires tmux 3.4+.
target_client ( str | None ) – Target client (-t flag).

In other ports Ask a client to confirm before running a command

Ruby No source-verified Ruby equivalent is recorded for this operation.
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript no equivalent on Server
Rust no equivalent on Server
Go tmux.Server.ConfirmBefore
Java no equivalent on Server
.NET LibTmux.Server.ConfirmBeforeAsync
C++ no equivalent on Server
Swift no equivalent on Server

0 declared, 0 inherited