Python API

method libtmux latest

Pane.choose_tree

Enter tree chooser via $ tmux choose-tree.

Source and package

Qualified name: libtmux.Pane.choose_tree
Module: libtmux
Declared in: Pane
Package: libtmux
Source: src/libtmux/pane.py
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScript Rust Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure

Examples#

>>> pane.choose_tree()

Parameters

sessions_collapsed (bool | None) # – Start with sessions collapsed (-s flag).
windows_collapsed (bool | None) # – Start with windows collapsed (-w flag).
format_string (str | None) # – Format for each item shown in the chooser (-F flag).
filter_expression (str | None) # – Filter expression evaluated per item; only items whose filter expands non-zero are shown (-f flag).
sort_order (t.Literal["index", "name", "time", "size"] | None) # – Sort field (-O flag).
reverse (bool | None) # – Reverse the sort order (-r flag).
zoom (bool | None) # – Zoom the pane while the chooser is active (-Z flag).

The tmux commands behind choose_tree.

The C declarations in tmux that implement these commands.

Open the session and window chooser in a pane

Equivalents of Open the session and window chooser in a pane in other languages
Language	Equivalent
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`pane.Pane.chooseTree`
Rust	no equivalent on `Pane`
Go	`tmux.Pane.ChooseTree`
Java	no equivalent on `Pane`
C#	`LibTmux.Pane.ChooseTreeAsync`
C++	no equivalent on `Pane`
Swift	no equivalent on `Pane`
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.