Enum zellij_utils::cli::CliAction

pub enum CliAction {
    Write {
        bytes: Vec<u8>,
    },
    WriteChars {
        chars: String,
    },
    Resize {
        resize: Resize,
        direction: Option<Direction>,
    },
    FocusNextPane,
    FocusPreviousPane,
    MoveFocus {
        direction: Direction,
    },
    MoveFocusOrTab {
        direction: Direction,
    },
    MovePane {
        direction: Option<Direction>,
    },
    MovePaneBackwards,
    Clear,
    DumpScreen {
        path: PathBuf,
        full: bool,
    },
    DumpLayout,
    EditScrollback,
    ScrollUp,
    ScrollDown,
    ScrollToBottom,
    ScrollToTop,
    PageScrollUp,
    PageScrollDown,
    HalfPageScrollUp,
    HalfPageScrollDown,
    ToggleFullscreen,
    TogglePaneFrames,
    ToggleActiveSyncTab,
    NewPane {

        direction: Option<Direction>,
        command: Vec<String>,
        plugin: Option<String>,
        cwd: Option<PathBuf>,
        floating: bool,
        in_place: bool,
        name: Option<String>,
        close_on_exit: bool,
        start_suspended: bool,
        configuration: Option<PluginUserConfiguration>,
        skip_plugin_cache: bool,
        x: Option<String>,
        y: Option<String>,
        width: Option<String>,
        height: Option<String>,
    
},
    Edit {
        file: PathBuf,
        direction: Option<Direction>,
        line_number: Option<usize>,
        floating: bool,
        in_place: bool,
        cwd: Option<PathBuf>,
        x: Option<String>,
        y: Option<String>,
        width: Option<String>,
        height: Option<String>,
    },
    SwitchMode {
        input_mode: InputMode,
    },
    TogglePaneEmbedOrFloating,
    ToggleFloatingPanes,
    ClosePane,
    RenamePane {
        name: String,
    },
    UndoRenamePane,
    GoToNextTab,
    GoToPreviousTab,
    CloseTab,
    GoToTab {
        index: u32,
    },
    GoToTabName {
        name: String,
        create: bool,
    },
    RenameTab {
        name: String,
    },
    UndoRenameTab,
    NewTab {
        layout: Option<PathBuf>,
        layout_dir: Option<PathBuf>,
        name: Option<String>,
        cwd: Option<PathBuf>,
    },
    MoveTab {
        direction: Direction,
    },
    PreviousSwapLayout,
    NextSwapLayout,
    QueryTabNames,
    StartOrReloadPlugin {
        url: String,
        configuration: Option<PluginUserConfiguration>,
    },
    LaunchOrFocusPlugin {
        floating: bool,
        in_place: bool,
        move_to_focused_tab: bool,
        url: String,
        configuration: Option<PluginUserConfiguration>,
        skip_plugin_cache: bool,
    },
    LaunchPlugin {
        floating: bool,
        in_place: bool,
        url: Url,
        configuration: Option<PluginUserConfiguration>,
        skip_plugin_cache: bool,
    },
    RenameSession {
        name: String,
    },
    Pipe {
        name: Option<String>,
        payload: Option<String>,
        args: Option<PluginUserConfiguration>,
        plugin: Option<String>,
        plugin_configuration: Option<PluginUserConfiguration>,
        force_launch_plugin: bool,
        skip_plugin_cache: bool,
        floating_plugin: Option<bool>,
        in_place_plugin: Option<bool>,
        plugin_cwd: Option<PathBuf>,
        plugin_title: Option<String>,
    },
    ListClients,
}

Variants

Write

Write bytes to the terminal.

Fields

bytes: Vec<u8>

WriteChars

Write characters to the terminal.

Fields

chars: String

Resize

[increase|decrease] the focused panes area at the [left|down|up|right] border.

Fields

resize: Resize

direction: Option<Direction>

FocusNextPane

Change focus to the next pane

FocusPreviousPane

Change focus to the previous pane

MoveFocus

Move the focused pane in the specified direction. [right|left|up|down]

Fields

direction: Direction

MoveFocusOrTab

Move focus to the pane or tab (if on screen edge) in the specified direction [right|left|up|down]

Fields

direction: Direction

MovePane

Change the location of the focused pane in the specified direction or rotate forwrads [right|left|up|down]

Fields

direction: Option<Direction>

MovePaneBackwards

Rotate the location of the previous pane backwards

Clear

Clear all buffers for a focused pane

DumpScreen

Dump the focused pane to a file

Fields

path: PathBuf

full: bool

Dump the pane with full scrollback

DumpLayout

Dump current layout to stdout

EditScrollback

Open the pane scrollback in your default editor

ScrollUp

Scroll up in the focused pane

ScrollDown

Scroll down in focus pane.

ScrollToBottom

Scroll down to bottom in focus pane.

ScrollToTop

Scroll up to top in focus pane.

PageScrollUp

Scroll up one page in focus pane.

PageScrollDown

Scroll down one page in focus pane.

HalfPageScrollUp

Scroll up half page in focus pane.

HalfPageScrollDown

Scroll down half page in focus pane.

ToggleFullscreen

Toggle between fullscreen focus pane and normal layout.

TogglePaneFrames

Toggle frames around panes in the UI

ToggleActiveSyncTab

Toggle between sending text commands to all panes on the current tab and normal mode.

NewPane

Open a new pane in the specified direction [right|down] If no direction is specified, will try to use the biggest available space.

Fields

direction: Option<Direction>

Direction to open the new pane in

command: Vec<String>

plugin: Option<String>

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

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 it after the you first press ENTER

configuration: Option<PluginUserConfiguration>

skip_plugin_cache: bool

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%)

Edit

Open the specified file in a new zellij pane with your default EDITOR

Fields

file: PathBuf

direction: Option<Direction>

Direction to open the new pane in

line_number: Option<usize>

Open the file in the specified line number

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

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%)

SwitchMode

Switch input mode of all connected clients [locked|pane|tab|resize|move|search|session]

Fields

input_mode: InputMode

TogglePaneEmbedOrFloating

Embed focused pane if floating or float focused pane if embedded

ToggleFloatingPanes

Toggle the visibility of all floating panes in the current Tab, open one if none exist

ClosePane

Close the focused pane.

RenamePane

Renames the focused pane

Fields

name: String

UndoRenamePane

Remove a previously set pane name

GoToNextTab

Go to the next tab.

GoToPreviousTab

Go to the previous tab.

CloseTab

Close the current tab.

GoToTab

Go to tab with index [index]

Fields

index: u32

GoToTabName

Go to tab with name [name]

Fields

name: String

create: bool

Create a tab if one does not exist.

RenameTab

Renames the focused pane

Fields

name: String

UndoRenameTab

Remove a previously set tab name

NewTab

Create a new tab, optionally with a specified tab layout and name

Fields

layout: Option<PathBuf>

Layout to use for the new tab

layout_dir: Option<PathBuf>

Default folder to look for layouts

name: Option<String>

Name of the new tab

cwd: Option<PathBuf>

Change the working directory of the new tab

MoveTab

Move the focused tab in the specified direction. [right|left]

Fields

direction: Direction

PreviousSwapLayout

NextSwapLayout

QueryTabNames

Query all tab names

StartOrReloadPlugin

Fields

url: String

configuration: Option<PluginUserConfiguration>

LaunchOrFocusPlugin

Fields

floating: bool

in_place: bool

move_to_focused_tab: bool

url: String

configuration: Option<PluginUserConfiguration>

skip_plugin_cache: bool

LaunchPlugin

Fields

floating: bool

in_place: bool

url: Url

configuration: Option<PluginUserConfiguration>

skip_plugin_cache: bool

RenameSession

Fields

name: String

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)

force_launch_plugin: bool

Launch a new plugin even if one is already running

skip_plugin_cache: bool

If launching a new plugin, skip cache and force-compile the plugin

floating_plugin: Option<bool>

If launching a plugin, should it be floating or not, defaults to floating

in_place_plugin: Option<bool>

If launching a plugin, launch it in-place (on top of the current pane)

plugin_cwd: Option<PathBuf>

If launching a plugin, specify its working directory

plugin_title: Option<String>

If launching a plugin, specify its pane title

ListClients

Trait Implementations

impl Clone for CliAction

fn clone(&self) -> CliAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CliAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CliAction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for CliAction

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 CliAction

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 CliAction

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