tmuxp shell - tmuxp.cli.shell

CLI for tmuxp shell subcommand.

class tmuxp.cli.shell.CLIShellNamespace

class

Bases: Namespace

Typed argparse.Namespace for tmuxp shell command.

color: CLIColorModeLiteral

attribute

session_name: str

attribute

socket_name: str | None

attribute

socket_path: str | None

attribute

colors: CLIColorsLiteral | None

attribute

log_file: str | None

attribute

window_name: str | None

attribute

command: str | None

attribute

shell: CLIShellLiteral | None

attribute

use_pythonrc: bool

attribute

use_vi_mode: bool

attribute

tmuxp.cli.shell.create_shell_subparser(parser)

function

Augment argparse.ArgumentParser with shell subcommand.

Parameters:

parser (ArgumentParser)

Return type:

ArgumentParser

tmuxp.cli.shell.command_shell(args, parser=None)

function

Entrypoint for tmuxp shell for tmux server, session, window and pane.

Priority given to loaded session/window/pane objects:

• session_name and window_name arguments

• current shell: envvar TMUX_PANE for determining window and session

• libtmux.Server.attached_sessions, libtmux.Session.active_window, libtmux.Window.active_pane

Parameters:

• args (CLIShellNamespace)

• parser (ArgumentParser | None)

Return type:

None