Enum Commands 

pub enum Commands {
    Attach {
        name: String,
    },
    Input {
        name: String,
        text: Option<String>,
    },
    Spawn {
        name: Option<String>,
        workdir: Option<String>,
        ink: Option<String>,
        description: Option<String>,
        detach: bool,
        idle_threshold: Option<u32>,
        auto: bool,
        worktree: bool,
        worktree_base: Option<String>,
        runtime: Option<String>,
        secret: Vec<String>,
        command: Vec<String>,
    },
    List {
        all: bool,
    },
    Logs {
        name: String,
        lines: usize,
        follow: bool,
    },
    Stop {
        names: Vec<String>,
        purge: bool,
    },
    Cleanup,
    Resume {
        name: String,
    },
    Nodes,
    Interventions {
        name: String,
    },
    Ui,
    Schedule {
        action: ScheduleAction,
    },
    Secret {
        action: SecretAction,
    },
    Worktree {
        action: WorktreeAction,
    },
}

Variants

Attach

Attach to a session’s terminal

Fields

name: String

Session name or ID

Input

Send input to a session

Fields

name: String

Session name or ID

text: Option<String>

Text to send (sends Enter if omitted)

Spawn

Spawn a new agent session

Fields

name: Option<String>

Session name (auto-generated from workdir if omitted)

workdir: Option<String>

Working directory (defaults to current directory)

ink: Option<String>

Ink name (from config)

description: Option<String>

Human-readable description of the task

detach: bool

Don’t attach to the session after spawning

idle_threshold: Option<u32>

Idle threshold in seconds (0 = never idle)

auto: bool

Auto-select the least loaded node

worktree: bool

Create an isolated git worktree for the session

worktree_base: Option<String>

Base branch to fork the worktree from (implies –worktree)

runtime: Option<String>

Runtime environment: tmux (default) or docker

secret: Vec<String>

Secrets to inject as environment variables (by name)

command: Vec<String>

Command to run (everything after –)

List

List sessions (live only by default)

Fields

all: bool

Show all sessions including stopped and lost

Logs

Show session logs/output

Fields

name: String

Session name or ID

lines: usize

Number of lines to fetch

follow: bool

Follow output (like tail -f)

Stop

Stop one or more sessions

Fields

names: Vec<String>

Session names or IDs

purge: bool

Also purge the session from history

Cleanup

Remove all stopped and lost sessions

Resume

Resume a lost session

Fields

name: String

Session name or ID

Nodes

List all known nodes

Interventions

Show intervention history for a session

Fields

name: String

Session name or ID

Ui

Open the web dashboard in your browser

Schedule

Manage scheduled agent runs

Fields

action: ScheduleAction

Secret

Manage secrets (environment variables injected into sessions)

Fields

action: SecretAction

Worktree

Manage git worktrees for sessions

Fields

action: WorktreeAction

Trait Implementations

impl Debug for Commands

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

Formats the value using the given formatter.

impl FromArgMatches for Commands

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 Commands

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