Core LibraryalphaAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

alpha Alpha release; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Topics Examples CLI Manual API Reference

concept Working example; may change without notice. Read more

v0.1.0.alpha.3

Current version

English

Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

Ruby API

class libtmux-ruby v0.1.0.alpha.3

Session

Base types LibTmux::Entity

Source and package

Qualified name: LibTmux::Session
Module: LibTmux
Package: libtmux
Source: gems/libtmux/lib/libtmux/entity.rb
Other languages: PowerShellcmdlet Juliastruct PythonLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaF#module

class LibTmux::Session class libtmux [source] ¶

Discussed in Server, session, window, pane

In other ports A tmux session

PowerShell
LibTmux\Get-TmuxSession
This cmdlet reads and returns shared .NET LibTmux.Session objects. Child windows and panes require further acquisition.
Julia
LibTmux.SessionSnapshot
SessionSnapshot holds captured session data. Actions use its SessionRef , a typed identity bound to an observed daemon generation.
Python
libtmux.Session
Lua
libtmux.Session
TypeScript
session.Session
Rust
session.Session
Go
tmux.Session
Java
io.github.libtmux.Session
C#
LibTmux.Session
C++
libtmux::Session
Swift
Session
Kotlin
io.github.libtmux.kotlin.Session
Scala
io.github.libtmux.scaladsl.Session
F#
LibTmux.FSharp.Session
This F# module builds deferred child queries from a shared .NET LibTmux.Session and its server association. Query.list acquires their results from tmux.

Members21#

Parent objects1#

server method Returns the value of attribute server.

Collections and queries2#

list_windows method Behavior: Live acquisition.
list_panes method Behavior: Live acquisition.

Common operations10#

new_window method Behavior: Creation.
kill method Both allowlists are required for guarded deletion of a changing topology.
rename method Behavior: Entity mutation.
hooks method Behavior: Options and hooks.
link_window method Behavior: Window links.
options method Behavior: Options and hooks.
environment method Behavior: Environment.
set_environment method Behavior: Environment.
unset_environment method Behavior: Environment.
list_window_links method Behavior: Live acquisition.

Other members8#

== method Behavior: Live handles.
display method Behavior: Formats.
eql? method Behavior: Live handles.
hash method Behavior: Live handles.
id method Behavior: Live handles.
inspect method Behavior: Live handles.
ref method Returns the value of attribute ref.
snapshot method Behavior: Snapshot acquisition.

Reference preview Open reference