Enum Command

pub enum Command {
    Resume {
        create: bool,
    },
    Start {
        name: Option<String>,
        program: Option<String>,
        args: Vec<String>,
        detached: bool,
    },
    Attach {
        session: SessionSelector,
        create: bool,
    },
    Select,
    Detach {
        session: Option<SessionSelector>,
    },
    Kill {
        session: SessionSelector,
    },
    List {
        info: bool,
        json: bool,
    },
    Shutdown,
}

Variants

Resume

Resume the last used session [alias: r]

Specify –create / -c to create a new session if one does not exist

Fields

create: bool

Create a new session if one does not exist

Start

Start a new session, optionally specifying a name [alias: s]

If no program is specified, the default shell will be used. If no name is specified, the name will be [program name]-[n-1] where n is the number of sessions with that program name. If –detached / -d is present, the session will not be attached to the client on creation and will run in the background.

Fields

name: Option<String>

program: Option<String>

args: Vec<String>

detached: bool

Attach

Attach to a session [alias: a]

Select a session by index or name. If –create / -c is present, a new session will be created if one does not exist. If the session was selected by name and the session was not present, the new session created by –create will have the specified name.

Fields

session: SessionSelector

Id or name of session

create: bool

Create a new session if one does not exist

Select

Fuzzy select a session to attach to [alias: f]

Opens a fuzzy selection window provided by the dialoguer crate. Type to fuzzy find files, or use the Up/Down arrows to navigate. Press Enter to confirm your selection, or Escape to cancel.

Detach

Detach from a session [alias: d]

If no session is specified, detaches from the current session (if it exists). Otherwise, detaches the specified session from its owning client.

Fields

session: Option<SessionSelector>

Id or name of session

Kill

Kill a session [alias: k]

Kills a session and the process it owns. Select a session by name or index.

Fields

session: SessionSelector

Id or name of session

List

List sessions [alias: ls]

Prints a compact list of session names and indexes. With the –info / -i option, prints a nicely formatted table with info about each session.

Fields

info: bool

Print detailed info about sessions

json: bool

Print session info as JSON, to be processed by another tool

Shutdown

Shutdown the server (kill all sessions)

Trait Implementations

impl Debug for Command

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

Formats the value using the given formatter.

impl FromArgMatches for Command

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 Subcommand for Command

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand