Enum Sessions 

pub enum Sessions {
    ListSessions {
        no_formatting: bool,
        short: bool,
        reverse: bool,
    },
    ListAliases,
    Attach {
        session_name: Option<String>,
        create: bool,
        create_background: bool,
        index: Option<usize>,
        options: Option<Box<SessionCommand>>,
        force_run_commands: bool,
        token: Option<String>,
        remember: bool,
        forget: bool,
        ca_cert: Option<PathBuf>,
        insecure: bool,
    },
    Watch {
        session_name: Option<String>,
    },
    KillSession {
        target_session: Option<String>,
    },
    DeleteSession {
        target_session: Option<String>,
        force: bool,
    },
    KillAllSessions {
        yes: bool,
    },
    DeleteAllSessions {
        yes: bool,
        force: bool,
    },
    Run {

        command: Vec<String>,
        direction: Option<Direction>,
        cwd: Option<PathBuf>,
        floating: bool,
        in_place: bool,
        close_replaced_pane: bool,
        name: Option<String>,
        close_on_exit: bool,
        start_suspended: bool,
        x: Option<String>,
        y: Option<String>,
        width: Option<String>,
        height: Option<String>,
        pinned: Option<bool>,
        stacked: bool,
        blocking: bool,
        block_until_exit_success: bool,
        block_until_exit_failure: bool,
        block_until_exit: bool,
        near_current_pane: bool,
        borderless: Option<bool>,
        tab_id: Option<usize>,
    
},
    Plugin {

        url: String,
        configuration: Option<PluginUserConfiguration>,
        floating: bool,
        in_place: bool,
        close_replaced_pane: bool,
        skip_plugin_cache: bool,
        x: Option<String>,
        y: Option<String>,
        width: Option<String>,
        height: Option<String>,
        pinned: Option<bool>,
        borderless: Option<bool>,
        tab_id: Option<usize>,
    
},
    Edit {

        file: PathBuf,
        line_number: Option<usize>,
        direction: Option<Direction>,
        in_place: bool,
        close_replaced_pane: bool,
        floating: bool,
        cwd: Option<PathBuf>,
        x: Option<String>,
        y: Option<String>,
        width: Option<String>,
        height: Option<String>,
        pinned: Option<bool>,
        near_current_pane: bool,
        borderless: Option<bool>,
        tab_id: Option<usize>,
    
},
    ConvertConfig {
        old_config_file: PathBuf,
    },
    ConvertLayout {
        old_layout_file: PathBuf,
    },
    ConvertTheme {
        old_theme_file: PathBuf,
    },
    Pipe {
        name: Option<String>,
        payload: Option<String>,
        args: Option<PluginUserConfiguration>,
        plugin: Option<String>,
        plugin_configuration: Option<PluginUserConfiguration>,
    },
}

Variants

ListSessions

List active sessions

Fields

no_formatting: bool

Do not add colors and formatting to the list (useful for parsing)

short: bool

Print just the session name

reverse: bool

List the sessions in reverse order (default is ascending order)

ListAliases

List existing plugin aliases

Attach

Attach to a session

Fields

session_name: Option<String>

Name of the session to attach to.

create: bool

Create a session if one does not exist.

create_background: bool

Create a detached session in the background if one does not exist

index: Option<usize>

Number of the session index in the active sessions ordered creation date.

options: Option<Box<SessionCommand>>

Change the behaviour of zellij

force_run_commands: bool

If resurrecting a dead session, immediately run all its commands on startup

token: Option<String>

Authentication token for remote sessions

remember: bool

Save session for automatic re-authentication (4 weeks)

forget: bool

Delete saved session before connecting

ca_cert: Option<PathBuf>

Path to a custom CA certificate (PEM format) for verifying the remote server

insecure: bool

Skip TLS certificate validation (DANGEROUS — development only)

Watch

Watch a session (read-only)

Fields

session_name: Option<String>

Name of the session to watch

KillSession

Kill a specific session

Fields

target_session: Option<String>

Name of target session

DeleteSession

Delete a specific session

Fields

target_session: Option<String>

Name of target session

force: bool

Kill the session if it’s running before deleting it

KillAllSessions

Kill all sessions

Fields

yes: bool

Automatic yes to prompts

DeleteAllSessions

Delete all sessions

Fields

yes: bool

Automatic yes to prompts

force: bool

Kill the sessions if they’re running before deleting them

Run

Run a command in a new pane Returns: Created pane ID (format: terminal_)

Fields

command: Vec<String>

Command to run

direction: Option<Direction>

Direction to open the new pane in

cwd: Option<PathBuf>

Change the working directory of the new pane

floating: bool

Open the new pane in floating mode

in_place: bool

Open the new pane in place of the current pane, temporarily suspending it

close_replaced_pane: bool

Close the replaced pane instead of suspending it (only effective with –in-place)

name: Option<String>

Name of the new pane

close_on_exit: bool

Close the pane immediately when its command exits

start_suspended: bool

Start the command suspended, only running after you first presses ENTER

x: Option<String>

The x coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

y: Option<String>

The y coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

width: Option<String>

The width if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

height: Option<String>

The height if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

pinned: Option<bool>

Whether to pin a floating pane so that it is always on top

stacked: bool

blocking: bool

Block until the command has finished and its pane has been closed

block_until_exit_success: bool

Block until the command exits successfully (exit status 0) OR its pane has been closed

block_until_exit_failure: bool

Block until the command exits with failure (non-zero exit status) OR its pane has been closed

block_until_exit: bool

Block until the command exits (regardless of exit status) OR its pane has been closed

near_current_pane: bool

if set, will open the pane near the current one rather than following the user’s focus

borderless: Option<bool>

start this pane without a border (warning: will make it impossible to move with the mouse)

tab_id: Option<usize>

Target a specific tab by ID

Plugin

Load a plugin Returns: Created pane ID (format: plugin_)

Fields

url: String

Plugin URL, can either start with http(s), file: or zellij:

configuration: Option<PluginUserConfiguration>

Plugin configuration

floating: bool

Open the new pane in floating mode

in_place: bool

Open the new pane in place of the current pane, temporarily suspending it

close_replaced_pane: bool

Close the replaced pane instead of suspending it (only effective with –in-place)

skip_plugin_cache: bool

Skip the memory and HD cache and force recompile of the plugin (good for development)

x: Option<String>

The x coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

y: Option<String>

The y coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

width: Option<String>

The width if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

height: Option<String>

The height if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

pinned: Option<bool>

Whether to pin a floating pane so that it is always on top

borderless: Option<bool>

start this pane without a border (warning: will make it impossible to move with the mouse)

tab_id: Option<usize>

Target a specific tab by ID

Edit

Edit file with default $EDITOR / $VISUAL Returns: Created pane ID (format: terminal_)

Fields

file: PathBuf

line_number: Option<usize>

Open the file in the specified line number

direction: Option<Direction>

Direction to open the new pane in

in_place: bool

Open the new pane in place of the current pane, temporarily suspending it

close_replaced_pane: bool

Close the replaced pane instead of suspending it (only effective with –in-place)

floating: bool

Open the new pane in floating mode

cwd: Option<PathBuf>

Change the working directory of the editor

x: Option<String>

The x coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

y: Option<String>

The y coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

width: Option<String>

The width if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

height: Option<String>

The height if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)

pinned: Option<bool>

Whether to pin a floating pane so that it is always on top

near_current_pane: bool

if set, will open the pane near the current one rather than following the user’s focus

borderless: Option<bool>

start this pane without a border (warning: will make it impossible to move with the mouse)

tab_id: Option<usize>

Target a specific tab by ID

ConvertConfig

Fields

old_config_file: PathBuf

ConvertLayout

Fields

old_layout_file: PathBuf

ConvertTheme

Fields

old_theme_file: PathBuf

Pipe

Send data to one or more plugins, launch them if they are not running.

Fields

name: Option<String>

The name of the pipe

payload: Option<String>

The data to send down this pipe (if blank, will listen to STDIN)

args: Option<PluginUserConfiguration>

The args of the pipe

plugin: Option<String>

The plugin url (eg. file:/tmp/my-plugin.wasm) to direct this pipe to, if not specified, will be sent to all plugins, if specified and is not running, the plugin will be launched

plugin_configuration: Option<PluginUserConfiguration>

The plugin configuration (note: the same plugin with different configuration is considered a different plugin for the purposes of determining the pipe destination)

Trait Implementations

impl Clone for Sessions

fn clone(&self) -> Sessions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Sessions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sessions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for Sessions

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Serialize for Sessions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Subcommand for Sessions

fn augment_subcommands<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can instantiate Self.

fn augment_subcommands_for_update<'b>(__clap_app: Command<'b>) -> Command<'b>

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand