Skip to main content

Command

Enum Command 

Source
pub enum Command {
Show 23 variants List, Up { profile: String, tab: Option<u32>, detach: bool, }, Attach { session: String, tab: Option<u32>, }, Down { session: String, }, New { name: String, tab: Vec<String>, color: String, detach: bool, }, Color { session: Option<String>, color: Option<String>, list: bool, }, Ps { profile: Option<String>, }, Ports { profile: Option<String>, }, Top { profile: Option<String>, }, Status, Peek { session: String, tabs: Vec<String>, lines: u32, }, Pin, Unpin, SyncRename { session: String, window: u32, name: String, }, PaneDied { session_name: String, window_name: String, pane_id: String, exit_code: i32, }, Bell { session_name: String, window_name: String, }, Profile { action: ProfileAction, }, Notifications { action: NotificationAction, }, Release { session: String, name: Option<String>, }, Adopt { session: String, name: Option<String>, color: String, save: bool, detach: bool, }, ShellInit { shell: String, }, ShellSuggest { dir: String, }, Settings { terminal: Option<String>, shell: Option<String>, tmux_path: Option<String>, },
}
Expand description

Top-level commands.

Variants§

§

List

List profiles and running sessions

§

Up

Create or attach to a profile’s session

Fields

§profile: String

Profile name or ID

§tab: Option<u32>

Switch to this tab index on attach

§detach: bool

Create session but don’t attach

§

Attach

Attach to a running session

Fields

§session: String

Profile name, ID, or session name

§tab: Option<u32>

Tab index to switch to

§

Down

Destroy a session

Fields

§session: String

Profile name, ID, or session name

§

New

Create an ad-hoc session

Fields

§name: String

Display name

§tab: Vec<String>

Tab definition (name:cwd[:command]), repeatable

§color: String

Color (hex)

§detach: bool

Create session but don’t attach

§

Color

Manage session colors

Fields

§session: Option<String>

Profile name, ID, or session name

§color: Option<String>

New color (hex or named)

§list: bool

List available named colors

§

Ps

Show processes running inside sessions

Fields

§profile: Option<String>

Profile name or ID (shows all sessions if omitted)

§

Ports

Show listening ports inside sessions

Fields

§profile: Option<String>

Profile name or ID (shows all sessions if omitted)

§

Top

Show resource usage (CPU, memory, GPU) for session processes

Fields

§profile: Option<String>

Profile name or ID (shows all sessions if omitted)

§

Status

Show all sessions with details

§

Peek

Peek at recent terminal output

Fields

§session: String

Profile name, ID, or session name

§tabs: Vec<String>

Tab names to show (all if omitted)

§lines: u32

Lines of output per tab

§

Pin

Pin the current tab to the session’s profile

§

Unpin

Unpin the current tab from the session’s profile

§

SyncRename

Sync a window rename to the profile (called by tmux hook)

Fields

§session: String

Session name

§window: u32

Window index

§name: String

New window name

§

PaneDied

Handle pane death notification (called by tmux hook)

Fields

§session_name: String
§window_name: String
§pane_id: String
§exit_code: i32
§

Bell

Handle bell notification (called by tmux hook)

Fields

§session_name: String
§window_name: String
§

Profile

Profile management

Fields

§

Notifications

Notification management

Fields

§

Release

Release a muster-managed session back to plain tmux

Fields

§session: String

Profile name, ID, or session name

§name: Option<String>

New name for the released session (defaults to session name without muster_ prefix)

§

Adopt

Adopt an existing tmux session under muster management

Fields

§session: String

Existing tmux session name

§name: Option<String>

Display name (defaults to session name)

§color: String

Color (hex or named)

§save: bool

Also save as a persistent profile

§detach: bool

Adopt without attaching

§

ShellInit

Output shell integration code for automatic profile suggestions on cd

Fields

§shell: String

Shell type: fish, bash, or zsh

§

ShellSuggest

Suggest profiles matching a directory (used by shell integration)

Fields

§dir: String

Directory path to match against profile CWDs

§

Settings

Show or update settings

Fields

§terminal: Option<String>

Set terminal emulator (e.g. ghostty, alacritty, kitty, wezterm, terminal, iterm2)

§shell: Option<String>

Set default shell

§tmux_path: Option<String>

Set tmux binary path

Trait Implementations§

Source§

impl FromArgMatches for Command

Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

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

Assign values from ArgMatches to self.
Source§

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

Assign values from ArgMatches to self.
Source§

impl Subcommand for Command

Source§

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

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

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 Read more
Source§

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.