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

tmuxp.workspace.builder.ClassicWorkspaceBuilder.__init__

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

API reference · Markdown

tmuxp.workspace.builder.ClassicWorkspaceBuilder.__init__ ( self , session_config : dict[str, t.Any] , server : Server , plugins : list[t.Any] | None = None , on_progress : t.Callable[[str], None] | None = None , on_before_script : t.Callable[[], None] | None = None , on_script_output : t.Callable[[str], None] | None = None , on_build_event : t.Callable[[dict[str, t.Any]], None] | None = None ) → None
method [source]
method [source]
tmuxp.workspace.builder.ClassicWorkspaceBuilder.__init__

Initialize workspace loading.

Parameters
  • session_config ( dict[str, t.Any] ) – session config, includes a list of windows.

  • server ( Server ) – tmux server to build session in

  • plugins ( list[t.Any] | None ) – plugins to be used for this session

  • on_progress ( t.Callable[[str], None] | None ) – callback for progress updates during building

  • on_before_script ( t.Callable[[], None] | None ) – called just before before_script runs; use to clear the terminal (e.g. stop a spinner) so script output is not interleaved

  • on_script_output ( t.Callable[[str], None] | None ) – called with each output line from before_script subprocess; when set, raw TTY tee is suppressed so the caller can route lines to a live panel instead

  • on_build_event ( t.Callable[[dict[str, t.Any]], None] | None ) – called with a dict event at each structural build milestone (session created, window started/done, pane creating, workspace built); used by the CLI to render a live session tree

Esc

Type to search.