740 lines
26 KiB
Rust
740 lines
26 KiB
Rust
use crate::data::{Direction, InputMode, Resize};
|
|
use crate::setup::Setup;
|
|
use crate::{
|
|
consts::{ZELLIJ_CONFIG_DIR_ENV, ZELLIJ_CONFIG_FILE_ENV},
|
|
input::{layout::PluginUserConfiguration, options::CliOptions},
|
|
};
|
|
use clap::{Parser, Subcommand};
|
|
use serde::{Deserialize, Serialize};
|
|
use std::path::PathBuf;
|
|
use url::Url;
|
|
|
|
fn validate_session(name: &str) -> Result<String, String> {
|
|
#[cfg(unix)]
|
|
{
|
|
use crate::consts::ZELLIJ_SOCK_MAX_LENGTH;
|
|
|
|
let mut socket_path = crate::consts::ZELLIJ_SOCK_DIR.clone();
|
|
socket_path.push(name);
|
|
|
|
if socket_path.as_os_str().len() >= ZELLIJ_SOCK_MAX_LENGTH {
|
|
// socket path must be less than 108 bytes
|
|
let available_length = ZELLIJ_SOCK_MAX_LENGTH
|
|
.saturating_sub(socket_path.as_os_str().len())
|
|
.saturating_sub(1);
|
|
|
|
return Err(format!(
|
|
"session name must be less than {} characters",
|
|
available_length
|
|
));
|
|
};
|
|
};
|
|
|
|
Ok(name.to_owned())
|
|
}
|
|
|
|
#[derive(Parser, Default, Debug, Clone, Serialize, Deserialize)]
|
|
#[clap(version, name = "zellij")]
|
|
pub struct CliArgs {
|
|
/// Maximum panes on screen, caution: opening more panes will close old ones
|
|
#[clap(long, value_parser)]
|
|
pub max_panes: Option<usize>,
|
|
|
|
/// Change where zellij looks for plugins
|
|
#[clap(long, value_parser, overrides_with = "data_dir")]
|
|
pub data_dir: Option<PathBuf>,
|
|
|
|
/// Run server listening at the specified socket path
|
|
#[clap(long, value_parser, hide = true, overrides_with = "server")]
|
|
pub server: Option<PathBuf>,
|
|
|
|
/// Specify name of a new session
|
|
#[clap(long, short, overrides_with = "session", value_parser = validate_session)]
|
|
pub session: Option<String>,
|
|
|
|
/// Name of a predefined layout inside the layout directory or the path to a layout file
|
|
#[clap(short, long, value_parser, overrides_with = "layout")]
|
|
pub layout: Option<PathBuf>,
|
|
|
|
/// Change where zellij looks for the configuration file
|
|
#[clap(short, long, overrides_with = "config", env = ZELLIJ_CONFIG_FILE_ENV, value_parser)]
|
|
pub config: Option<PathBuf>,
|
|
|
|
/// Change where zellij looks for the configuration directory
|
|
#[clap(long, overrides_with = "config_dir", env = ZELLIJ_CONFIG_DIR_ENV, value_parser)]
|
|
pub config_dir: Option<PathBuf>,
|
|
|
|
#[clap(subcommand)]
|
|
pub command: Option<Command>,
|
|
|
|
/// Specify emitting additional debug information
|
|
#[clap(short, long, value_parser)]
|
|
pub debug: bool,
|
|
}
|
|
|
|
#[derive(Debug, Subcommand, Clone, Serialize, Deserialize)]
|
|
pub enum Command {
|
|
/// Change the behaviour of zellij
|
|
#[clap(name = "options", value_parser)]
|
|
Options(CliOptions),
|
|
|
|
/// Setup zellij and check its configuration
|
|
#[clap(name = "setup", value_parser)]
|
|
Setup(Setup),
|
|
|
|
/// Explore existing zellij sessions
|
|
#[clap(flatten)]
|
|
Sessions(Sessions),
|
|
}
|
|
|
|
#[derive(Debug, Subcommand, Clone, Serialize, Deserialize)]
|
|
pub enum SessionCommand {
|
|
/// Change the behaviour of zellij
|
|
#[clap(name = "options")]
|
|
Options(CliOptions),
|
|
}
|
|
|
|
#[derive(Debug, Subcommand, Clone, Serialize, Deserialize)]
|
|
pub enum Sessions {
|
|
/// List active sessions
|
|
#[clap(visible_alias = "ls")]
|
|
ListSessions {
|
|
/// Do not add colors and formatting to the list (useful for parsing)
|
|
#[clap(short, long, value_parser, takes_value(false), default_value("false"))]
|
|
no_formatting: bool,
|
|
|
|
/// Print just the session name
|
|
#[clap(short, long, value_parser, takes_value(false), default_value("false"))]
|
|
short: bool,
|
|
|
|
/// List the sessions in reverse order (default is ascending order)
|
|
#[clap(short, long, value_parser, takes_value(false), default_value("false"))]
|
|
reverse: bool,
|
|
},
|
|
/// List existing plugin aliases
|
|
#[clap(visible_alias = "la")]
|
|
ListAliases,
|
|
/// Attach to a session
|
|
#[clap(visible_alias = "a")]
|
|
Attach {
|
|
/// Name of the session to attach to.
|
|
#[clap(value_parser)]
|
|
session_name: Option<String>,
|
|
|
|
/// Create a session if one does not exist.
|
|
#[clap(short, long, value_parser)]
|
|
create: bool,
|
|
|
|
/// Create a detached session in the background if one does not exist
|
|
#[clap(short('b'), long, value_parser)]
|
|
create_background: bool,
|
|
|
|
/// Number of the session index in the active sessions ordered creation date.
|
|
#[clap(long, value_parser)]
|
|
index: Option<usize>,
|
|
|
|
/// Change the behaviour of zellij
|
|
#[clap(subcommand, name = "options")]
|
|
options: Option<Box<SessionCommand>>,
|
|
|
|
/// If resurrecting a dead session, immediately run all its commands on startup
|
|
#[clap(short, long, value_parser, takes_value(false), default_value("false"))]
|
|
force_run_commands: bool,
|
|
},
|
|
|
|
/// Kill a specific session
|
|
#[clap(visible_alias = "k")]
|
|
KillSession {
|
|
/// Name of target session
|
|
#[clap(value_parser)]
|
|
target_session: Option<String>,
|
|
},
|
|
|
|
/// Delete a specific session
|
|
#[clap(visible_alias = "d")]
|
|
DeleteSession {
|
|
/// Name of target session
|
|
#[clap(value_parser)]
|
|
target_session: Option<String>,
|
|
/// Kill the session if it's running before deleting it
|
|
#[clap(short, long, value_parser, takes_value(false), default_value("false"))]
|
|
force: bool,
|
|
},
|
|
|
|
/// Kill all sessions
|
|
#[clap(visible_alias = "ka")]
|
|
KillAllSessions {
|
|
/// Automatic yes to prompts
|
|
#[clap(short, long, value_parser)]
|
|
yes: bool,
|
|
},
|
|
|
|
/// Delete all sessions
|
|
#[clap(visible_alias = "da")]
|
|
DeleteAllSessions {
|
|
/// Automatic yes to prompts
|
|
#[clap(short, long, value_parser)]
|
|
yes: bool,
|
|
/// Kill the sessions if they're running before deleting them
|
|
#[clap(short, long, value_parser, takes_value(false), default_value("false"))]
|
|
force: bool,
|
|
},
|
|
|
|
/// Send actions to a specific session
|
|
#[clap(visible_alias = "ac")]
|
|
#[clap(subcommand)]
|
|
Action(CliAction),
|
|
/// Run a command in a new pane
|
|
#[clap(visible_alias = "r")]
|
|
Run {
|
|
/// Command to run
|
|
#[clap(last(true), required(true))]
|
|
command: Vec<String>,
|
|
|
|
/// Direction to open the new pane in
|
|
#[clap(short, long, value_parser, conflicts_with("floating"))]
|
|
direction: Option<Direction>,
|
|
|
|
/// Change the working directory of the new pane
|
|
#[clap(long, value_parser)]
|
|
cwd: Option<PathBuf>,
|
|
|
|
/// Open the new pane in floating mode
|
|
#[clap(short, long, value_parser, default_value("false"), takes_value(false))]
|
|
floating: bool,
|
|
|
|
/// Open the new pane in place of the current pane, temporarily suspending it
|
|
#[clap(
|
|
short,
|
|
long,
|
|
value_parser,
|
|
default_value("false"),
|
|
takes_value(false),
|
|
conflicts_with("floating"),
|
|
conflicts_with("direction")
|
|
)]
|
|
in_place: bool,
|
|
|
|
/// Name of the new pane
|
|
#[clap(short, long, value_parser)]
|
|
name: Option<String>,
|
|
|
|
/// Close the pane immediately when its command exits
|
|
#[clap(short, long, value_parser, default_value("false"), takes_value(false))]
|
|
close_on_exit: bool,
|
|
|
|
/// Start the command suspended, only running after you first presses ENTER
|
|
#[clap(short, long, value_parser, default_value("false"), takes_value(false))]
|
|
start_suspended: bool,
|
|
|
|
/// The x coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
x: Option<String>,
|
|
/// The y coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
y: Option<String>,
|
|
/// The width if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
width: Option<String>,
|
|
/// The height if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
height: Option<String>,
|
|
},
|
|
/// Load a plugin
|
|
#[clap(visible_alias = "p")]
|
|
Plugin {
|
|
/// Plugin URL, can either start with http(s), file: or zellij:
|
|
#[clap(last(true), required(true))]
|
|
url: String,
|
|
|
|
/// Plugin configuration
|
|
#[clap(short, long, value_parser)]
|
|
configuration: Option<PluginUserConfiguration>,
|
|
|
|
/// Open the new pane in floating mode
|
|
#[clap(short, long, value_parser, default_value("false"), takes_value(false))]
|
|
floating: bool,
|
|
|
|
/// Open the new pane in place of the current pane, temporarily suspending it
|
|
#[clap(
|
|
short,
|
|
long,
|
|
value_parser,
|
|
default_value("false"),
|
|
takes_value(false),
|
|
conflicts_with("floating")
|
|
)]
|
|
in_place: bool,
|
|
|
|
/// Skip the memory and HD cache and force recompile of the plugin (good for development)
|
|
#[clap(short, long, value_parser, default_value("false"), takes_value(false))]
|
|
skip_plugin_cache: bool,
|
|
/// The x coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
x: Option<String>,
|
|
/// The y coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
y: Option<String>,
|
|
/// The width if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
width: Option<String>,
|
|
/// The height if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
height: Option<String>,
|
|
},
|
|
/// Edit file with default $EDITOR / $VISUAL
|
|
#[clap(visible_alias = "e")]
|
|
Edit {
|
|
file: PathBuf,
|
|
|
|
/// Open the file in the specified line number
|
|
#[clap(short, long, value_parser)]
|
|
line_number: Option<usize>,
|
|
|
|
/// Direction to open the new pane in
|
|
#[clap(short, long, value_parser, conflicts_with("floating"))]
|
|
direction: Option<Direction>,
|
|
|
|
/// Open the new pane in place of the current pane, temporarily suspending it
|
|
#[clap(
|
|
short,
|
|
long,
|
|
value_parser,
|
|
default_value("false"),
|
|
takes_value(false),
|
|
conflicts_with("floating"),
|
|
conflicts_with("direction")
|
|
)]
|
|
in_place: bool,
|
|
|
|
/// Open the new pane in floating mode
|
|
#[clap(short, long, value_parser, default_value("false"), takes_value(false))]
|
|
floating: bool,
|
|
|
|
/// Change the working directory of the editor
|
|
#[clap(long, value_parser)]
|
|
cwd: Option<PathBuf>,
|
|
/// The x coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
x: Option<String>,
|
|
/// The y coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
y: Option<String>,
|
|
/// The width if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
width: Option<String>,
|
|
/// The height if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
height: Option<String>,
|
|
},
|
|
ConvertConfig {
|
|
old_config_file: PathBuf,
|
|
},
|
|
ConvertLayout {
|
|
old_layout_file: PathBuf,
|
|
},
|
|
ConvertTheme {
|
|
old_theme_file: PathBuf,
|
|
},
|
|
/// Send data to one or more plugins, launch them if they are not running.
|
|
#[clap(override_usage(
|
|
r#"
|
|
zellij pipe [OPTIONS] [--] <PAYLOAD>
|
|
|
|
* Send data to a specific plugin:
|
|
|
|
zellij pipe --plugin file:/path/to/my/plugin.wasm --name my_pipe_name -- my_arbitrary_data
|
|
|
|
* To all running plugins (that are listening):
|
|
|
|
zellij pipe --name my_pipe_name -- my_arbitrary_data
|
|
|
|
* Pipe data into this command's STDIN and get output from the plugin on this command's STDOUT
|
|
|
|
tail -f /tmp/my-live-logfile | zellij pipe --name logs --plugin https://example.com/my-plugin.wasm | wc -l
|
|
"#))]
|
|
Pipe {
|
|
/// The name of the pipe
|
|
#[clap(short, long, value_parser, display_order(1))]
|
|
name: Option<String>,
|
|
/// The data to send down this pipe (if blank, will listen to STDIN)
|
|
payload: Option<String>,
|
|
|
|
#[clap(short, long, value_parser, display_order(2))]
|
|
/// The args of the pipe
|
|
args: Option<PluginUserConfiguration>, // TODO: we might want to not re-use
|
|
// PluginUserConfiguration
|
|
/// 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
|
|
#[clap(short, long, value_parser, display_order(3))]
|
|
plugin: Option<String>,
|
|
/// The plugin configuration (note: the same plugin with different configuration is
|
|
/// considered a different plugin for the purposes of determining the pipe destination)
|
|
#[clap(short('c'), long, value_parser, display_order(4))]
|
|
plugin_configuration: Option<PluginUserConfiguration>,
|
|
},
|
|
}
|
|
|
|
#[derive(Debug, Subcommand, Clone, Serialize, Deserialize)]
|
|
pub enum CliAction {
|
|
/// Write bytes to the terminal.
|
|
Write {
|
|
bytes: Vec<u8>,
|
|
},
|
|
/// Write characters to the terminal.
|
|
WriteChars {
|
|
chars: String,
|
|
},
|
|
/// [increase|decrease] the focused panes area at the [left|down|up|right] border.
|
|
Resize {
|
|
resize: Resize,
|
|
direction: Option<Direction>,
|
|
},
|
|
/// Change focus to the next pane
|
|
FocusNextPane,
|
|
/// Change focus to the previous pane
|
|
FocusPreviousPane,
|
|
/// Move the focused pane in the specified direction. [right|left|up|down]
|
|
MoveFocus {
|
|
direction: Direction,
|
|
},
|
|
/// Move focus to the pane or tab (if on screen edge) in the specified direction
|
|
/// [right|left|up|down]
|
|
MoveFocusOrTab {
|
|
direction: Direction,
|
|
},
|
|
/// Change the location of the focused pane in the specified direction or rotate forwrads
|
|
/// [right|left|up|down]
|
|
MovePane {
|
|
direction: Option<Direction>,
|
|
},
|
|
/// Rotate the location of the previous pane backwards
|
|
MovePaneBackwards,
|
|
/// Clear all buffers for a focused pane
|
|
Clear,
|
|
/// Dump the focused pane to a file
|
|
DumpScreen {
|
|
path: PathBuf,
|
|
|
|
/// Dump the pane with full scrollback
|
|
#[clap(short, long, value_parser, default_value("false"), takes_value(false))]
|
|
full: bool,
|
|
},
|
|
/// Dump current layout to stdout
|
|
DumpLayout,
|
|
/// Open the pane scrollback in your default editor
|
|
EditScrollback,
|
|
/// Scroll up in the focused pane
|
|
ScrollUp,
|
|
/// Scroll down in focus pane.
|
|
ScrollDown,
|
|
/// Scroll down to bottom in focus pane.
|
|
ScrollToBottom,
|
|
/// Scroll up to top in focus pane.
|
|
ScrollToTop,
|
|
/// Scroll up one page in focus pane.
|
|
PageScrollUp,
|
|
/// Scroll down one page in focus pane.
|
|
PageScrollDown,
|
|
/// Scroll up half page in focus pane.
|
|
HalfPageScrollUp,
|
|
/// Scroll down half page in focus pane.
|
|
HalfPageScrollDown,
|
|
/// Toggle between fullscreen focus pane and normal layout.
|
|
ToggleFullscreen,
|
|
/// Toggle frames around panes in the UI
|
|
TogglePaneFrames,
|
|
/// Toggle between sending text commands to all panes on the current tab and normal mode.
|
|
ToggleActiveSyncTab,
|
|
/// Open a new pane in the specified direction [right|down]
|
|
/// If no direction is specified, will try to use the biggest available space.
|
|
NewPane {
|
|
/// Direction to open the new pane in
|
|
#[clap(short, long, value_parser, conflicts_with("floating"))]
|
|
direction: Option<Direction>,
|
|
|
|
#[clap(last(true))]
|
|
command: Vec<String>,
|
|
|
|
#[clap(short, long, conflicts_with("command"), conflicts_with("direction"))]
|
|
plugin: Option<String>,
|
|
|
|
/// Change the working directory of the new pane
|
|
#[clap(long, value_parser)]
|
|
cwd: Option<PathBuf>,
|
|
|
|
/// Open the new pane in floating mode
|
|
#[clap(short, long, value_parser, default_value("false"), takes_value(false))]
|
|
floating: bool,
|
|
|
|
/// Open the new pane in place of the current pane, temporarily suspending it
|
|
#[clap(
|
|
short,
|
|
long,
|
|
value_parser,
|
|
default_value("false"),
|
|
takes_value(false),
|
|
conflicts_with("floating"),
|
|
conflicts_with("direction")
|
|
)]
|
|
in_place: bool,
|
|
|
|
/// Name of the new pane
|
|
#[clap(short, long, value_parser)]
|
|
name: Option<String>,
|
|
|
|
/// Close the pane immediately when its command exits
|
|
#[clap(
|
|
short,
|
|
long,
|
|
value_parser,
|
|
default_value("false"),
|
|
takes_value(false),
|
|
requires("command")
|
|
)]
|
|
close_on_exit: bool,
|
|
/// Start the command suspended, only running it after the you first press ENTER
|
|
#[clap(
|
|
short,
|
|
long,
|
|
value_parser,
|
|
default_value("false"),
|
|
takes_value(false),
|
|
requires("command")
|
|
)]
|
|
start_suspended: bool,
|
|
#[clap(long, value_parser)]
|
|
configuration: Option<PluginUserConfiguration>,
|
|
#[clap(long, value_parser)]
|
|
skip_plugin_cache: bool,
|
|
/// The x coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
x: Option<String>,
|
|
/// The y coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
y: Option<String>,
|
|
/// The width if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
width: Option<String>,
|
|
/// The height if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
height: Option<String>,
|
|
},
|
|
/// Open the specified file in a new zellij pane with your default EDITOR
|
|
Edit {
|
|
file: PathBuf,
|
|
|
|
/// Direction to open the new pane in
|
|
#[clap(short, long, value_parser, conflicts_with("floating"))]
|
|
direction: Option<Direction>,
|
|
|
|
/// Open the file in the specified line number
|
|
#[clap(short, long, value_parser)]
|
|
line_number: Option<usize>,
|
|
|
|
/// Open the new pane in floating mode
|
|
#[clap(short, long, value_parser, default_value("false"), takes_value(false))]
|
|
floating: bool,
|
|
|
|
/// Open the new pane in place of the current pane, temporarily suspending it
|
|
#[clap(
|
|
short,
|
|
long,
|
|
value_parser,
|
|
default_value("false"),
|
|
takes_value(false),
|
|
conflicts_with("floating"),
|
|
conflicts_with("direction")
|
|
)]
|
|
in_place: bool,
|
|
|
|
/// Change the working directory of the editor
|
|
#[clap(long, value_parser)]
|
|
cwd: Option<PathBuf>,
|
|
/// The x coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
x: Option<String>,
|
|
/// The y coordinates if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(short, long, requires("floating"))]
|
|
y: Option<String>,
|
|
/// The width if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
width: Option<String>,
|
|
/// The height if the pane is floating as a bare integer (eg. 1) or percent (eg. 10%)
|
|
#[clap(long, requires("floating"))]
|
|
height: Option<String>,
|
|
},
|
|
/// Switch input mode of all connected clients [locked|pane|tab|resize|move|search|session]
|
|
SwitchMode {
|
|
input_mode: InputMode,
|
|
},
|
|
/// Embed focused pane if floating or float focused pane if embedded
|
|
TogglePaneEmbedOrFloating,
|
|
/// Toggle the visibility of all floating panes in the current Tab, open one if none exist
|
|
ToggleFloatingPanes,
|
|
/// Close the focused pane.
|
|
ClosePane,
|
|
/// Renames the focused pane
|
|
RenamePane {
|
|
name: String,
|
|
},
|
|
/// Remove a previously set pane name
|
|
UndoRenamePane,
|
|
/// Go to the next tab.
|
|
GoToNextTab,
|
|
/// Go to the previous tab.
|
|
GoToPreviousTab,
|
|
/// Close the current tab.
|
|
CloseTab,
|
|
/// Go to tab with index [index]
|
|
GoToTab {
|
|
index: u32,
|
|
},
|
|
/// Go to tab with name [name]
|
|
GoToTabName {
|
|
name: String,
|
|
/// Create a tab if one does not exist.
|
|
#[clap(short, long, value_parser)]
|
|
create: bool,
|
|
},
|
|
/// Renames the focused pane
|
|
RenameTab {
|
|
name: String,
|
|
},
|
|
/// Remove a previously set tab name
|
|
UndoRenameTab,
|
|
/// Create a new tab, optionally with a specified tab layout and name
|
|
NewTab {
|
|
/// Layout to use for the new tab
|
|
#[clap(short, long, value_parser)]
|
|
layout: Option<PathBuf>,
|
|
|
|
/// Default folder to look for layouts
|
|
#[clap(long, value_parser, requires("layout"))]
|
|
layout_dir: Option<PathBuf>,
|
|
|
|
/// Name of the new tab
|
|
#[clap(short, long, value_parser)]
|
|
name: Option<String>,
|
|
|
|
/// Change the working directory of the new tab
|
|
#[clap(short, long, value_parser, requires("layout"))]
|
|
cwd: Option<PathBuf>,
|
|
},
|
|
/// Move the focused tab in the specified direction. [right|left]
|
|
MoveTab {
|
|
direction: Direction,
|
|
},
|
|
PreviousSwapLayout,
|
|
NextSwapLayout,
|
|
/// Query all tab names
|
|
QueryTabNames,
|
|
StartOrReloadPlugin {
|
|
url: String,
|
|
#[clap(short, long, value_parser)]
|
|
configuration: Option<PluginUserConfiguration>,
|
|
},
|
|
LaunchOrFocusPlugin {
|
|
#[clap(short, long, value_parser)]
|
|
floating: bool,
|
|
#[clap(short, long, value_parser)]
|
|
in_place: bool,
|
|
#[clap(short, long, value_parser)]
|
|
move_to_focused_tab: bool,
|
|
url: String,
|
|
#[clap(short, long, value_parser)]
|
|
configuration: Option<PluginUserConfiguration>,
|
|
#[clap(short, long, value_parser)]
|
|
skip_plugin_cache: bool,
|
|
},
|
|
LaunchPlugin {
|
|
#[clap(short, long, value_parser)]
|
|
floating: bool,
|
|
#[clap(short, long, value_parser)]
|
|
in_place: bool,
|
|
url: Url,
|
|
#[clap(short, long, value_parser)]
|
|
configuration: Option<PluginUserConfiguration>,
|
|
#[clap(short, long, value_parser)]
|
|
skip_plugin_cache: bool,
|
|
},
|
|
RenameSession {
|
|
name: String,
|
|
},
|
|
/// Send data to one or more plugins, launch them if they are not running.
|
|
#[clap(override_usage(
|
|
r#"
|
|
zellij action pipe [OPTIONS] [--] <PAYLOAD>
|
|
|
|
* Send data to a specific plugin:
|
|
|
|
zellij action pipe --plugin file:/path/to/my/plugin.wasm --name my_pipe_name -- my_arbitrary_data
|
|
|
|
* To all running plugins (that are listening):
|
|
|
|
zellij action pipe --name my_pipe_name -- my_arbitrary_data
|
|
|
|
* Pipe data into this command's STDIN and get output from the plugin on this command's STDOUT
|
|
|
|
tail -f /tmp/my-live-logfile | zellij action pipe --name logs --plugin https://example.com/my-plugin.wasm | wc -l
|
|
"#))]
|
|
Pipe {
|
|
/// The name of the pipe
|
|
#[clap(short, long, value_parser, display_order(1))]
|
|
name: Option<String>,
|
|
/// The data to send down this pipe (if blank, will listen to STDIN)
|
|
payload: Option<String>,
|
|
|
|
#[clap(short, long, value_parser, display_order(2))]
|
|
/// The args of the pipe
|
|
args: Option<PluginUserConfiguration>, // TODO: we might want to not re-use
|
|
// PluginUserConfiguration
|
|
/// 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
|
|
#[clap(short, long, value_parser, display_order(3))]
|
|
plugin: Option<String>,
|
|
/// The plugin configuration (note: the same plugin with different configuration is
|
|
/// considered a different plugin for the purposes of determining the pipe destination)
|
|
#[clap(short('c'), long, value_parser, display_order(4))]
|
|
plugin_configuration: Option<PluginUserConfiguration>,
|
|
/// Launch a new plugin even if one is already running
|
|
#[clap(
|
|
short('l'),
|
|
long,
|
|
value_parser,
|
|
takes_value(false),
|
|
default_value("false"),
|
|
display_order(5)
|
|
)]
|
|
force_launch_plugin: bool,
|
|
/// If launching a new plugin, skip cache and force-compile the plugin
|
|
#[clap(
|
|
short('s'),
|
|
long,
|
|
value_parser,
|
|
takes_value(false),
|
|
default_value("false"),
|
|
display_order(6)
|
|
)]
|
|
skip_plugin_cache: bool,
|
|
/// If launching a plugin, should it be floating or not, defaults to floating
|
|
#[clap(short('f'), long, value_parser, display_order(7))]
|
|
floating_plugin: Option<bool>,
|
|
/// If launching a plugin, launch it in-place (on top of the current pane)
|
|
#[clap(
|
|
short('i'),
|
|
long,
|
|
value_parser,
|
|
conflicts_with("floating-plugin"),
|
|
display_order(8)
|
|
)]
|
|
in_place_plugin: Option<bool>,
|
|
/// If launching a plugin, specify its working directory
|
|
#[clap(short('w'), long, value_parser, display_order(9))]
|
|
plugin_cwd: Option<PathBuf>,
|
|
/// If launching a plugin, specify its pane title
|
|
#[clap(short('t'), long, value_parser, display_order(10))]
|
|
plugin_title: Option<String>,
|
|
},
|
|
ListClients,
|
|
}
|