Server.search_sessions
Sessions, optionally filtered by tmux before rows are returned.
Source and package
-
Description#
Like
Server.sessionsbut adds an optionalfilterkwarg passed to$ tmux list-sessions -f <filter>.Examples#
>>> server.new_session(session_name='gap7_alpha')Session($... gap7_alpha)>>> server.new_session(session_name='other_beta')Session($... other_beta)>>> matches = server.search_sessions(filter='#{m:gap7_*,#{session_name}}')>>> [s.session_name for s in matches]['gap7_alpha']- Parameters
-
-
filter(str | None) # – tmux format expression (-fflag). tmux omits sessions whose expanded expression is false before libtmux builds objects. tmux silently expands a malformed filter (unclosed#{...}, unknown format token) to empty, which the filter treats as false — every row is suppressed and no stderr is emitted. A bad filter is indistinguishable from "filter matched nothing"; verify filter syntax against the FORMATS section oftmux(1). Warning: added 0.57
-
- Returns
tmux command#
The tmux commands behind search_sessions.
tmux C API#
The C declarations in tmux that implement these commands.
Guides#
Pages that discuss search_sessions.
In other ports#
Filter the sessions with a tmux expression
| Language | Equivalent |
|---|---|
| Lua | libtmux |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | no equivalent on Server |
| Rust | no equivalent on Server |
| Go | tmux |
| Java | no equivalent on Server |
| C# | Lib |
| C++ | no equivalent on Server |
| Swift | no equivalent on Server |
| 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, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.