Python API

method libtmux stable

Server.new_session

Create new session, returns new Session .

Source and package

Qualified name: libtmux.Server.new_session
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: PowerShell Julia RubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScala F#

Description#

Uses -P flag to print session info, -F for return formatting returns new Session object.

$ tmux new-session -d will create the session in the background $ tmux new-session -Ad will move to the session name if it already exists. todo: make an option to handle this.

Sessions can be created without a session name (0.14.2+):

>>> server.new_session()
Session($2 2)

Creating them in succession will enumerate IDs (via tmux):

>>> server.new_session()
Session($3 3)

>>> server.new_session(session_name='my session')
Session($4 my session)

Parameters

session_name (str | None) # – :: $ tmux new-session -s <session_name>
kill_session (bool) #
attach (bool) # – create session in the foreground. attach=False is equivalent to:: $ tmux new-session -d
start_directory (StrPath | None) #
window_name (str | None) #
window_command (str | None) #
x (int | DashLiteral | None) #
y (int | DashLiteral | None) #
environment (dict[str, str] | None) #
args (t.Any) #
detach_others (bool | None) #
no_size (bool | None) #
client_flags (str | None) #
kwargs (t.Any) #

Returns

Session

Raises

In other ports Create a session