Struct TmuxSessionBuilder 

pub struct TmuxSessionBuilder { /* private fields */ }

Builder that accumulates tmux operations for creating and configuring a session.

Can either execute operations against a live tmux server or return them as command strings for testing and dry-run.

Examples

use git_paw::tmux::{TmuxSessionBuilder, PaneSpec};

let session = TmuxSessionBuilder::new("my-project")
    .add_pane(PaneSpec {
        branch: "feat/auth".into(),
        worktree: "/tmp/my-project-feat-auth".into(),
        cli_command: "claude".into(),
    })
    .mouse_mode(true)
    .build()?;

// Dry-run: inspect commands
for cmd in session.command_strings() {
    println!("{cmd}");
}

// Or execute for real
session.execute()?;

Implementations

impl TmuxSessionBuilder

pub fn new(project_name: &str) -> Self

Create a new builder for the given project name.

The session will be named paw-<project_name> unless overridden with session_name.

pub fn session_name(self, name: String) -> Self

Override the session name instead of deriving it from the project name.

Use this with resolve_session_name to handle name collisions.

pub fn add_pane(self, spec: PaneSpec) -> Self

Add a pane that will cd into the worktree and run the CLI command.

pub fn mouse_mode(self, enabled: bool) -> Self

Enable or disable mouse mode for the session (default: true).

When enabled, users can click to switch panes, drag borders to resize, and scroll. This is set per-session and does not affect other tmux sessions.

pub fn border_affordances(self, enabled: bool) -> Self

Enable or disable the border affordances for the session (default: true).

When enabled, the session receives heavy borders, dim/active border styling, and a per-pane label strip, and each pane’s title is set to its role/branch id. When disabled, none of these set-option or select-pane -T invocations are emitted and the session inherits the user’s default tmux styling. Driven by [layout].border_affordances.

pub fn set_environment(self, key: &str, value: &str) -> Self

Set a session-level environment variable.

The resulting tmux set-environment -t <session> <key> <value> command is emitted before any send-keys commands so all panes inherit it.

pub fn build(self) -> Result<TmuxSession, PawError>

Build the full sequence of tmux commands without executing anything.

Returns a TmuxSession that can be executed or inspected. Returns an error if no panes have been added.

Trait Implementations

impl Debug for TmuxSessionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.