Enum Commands 

pub enum Commands {
    Attach {
        name: String,
    },
    Input {
        name: String,
        text: Option<String>,
    },
    Spawn {

        workdir: String,
        name: Option<String>,
        provider: String,
        auto: bool,
        guard: String,
        model: Option<String>,
        system_prompt: Option<String>,
        allowed_tools: Option<Vec<String>>,
        ink: Option<String>,
        max_turns: Option<u32>,
        max_budget: Option<f64>,
        output_format: Option<String>,
        prompt: Vec<String>,
    
},
    List,
    Logs {
        name: String,
        lines: usize,
        follow: bool,
    },
    Kill {
        name: String,
    },
    Delete {
        name: String,
    },
    Resume {
        name: String,
    },
    Nodes,
    Interventions {
        name: String,
    },
    Ui,
    Schedule {
        action: ScheduleAction,
    },
}

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

workdir: String

Working directory

name: Option<String>

Session name (auto-derived from workdir if omitted)

provider: String

Agent provider (claude, codex, gemini, opencode)

auto: bool

Run in autonomous mode (fire-and-forget)

guard: String

Guard preset (strict, standard, unrestricted)

model: Option<String>

Model override (e.g. opus, sonnet)

system_prompt: Option<String>

System prompt to append

allowed_tools: Option<Vec<String>>

Explicit allowed tools (comma-separated)

ink: Option<String>

Ink name (from config)

max_turns: Option<u32>

Maximum agent turns before stopping

max_budget: Option<f64>

Maximum budget in USD before stopping

output_format: Option<String>

Output format (e.g. json, stream-json)

prompt: Vec<String>

Task prompt

List

List all sessions

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)

Kill

Kill a session

Fields

name: String

Session name or ID

Delete

Permanently remove a session from history

Fields

name: String

Session name or ID

Resume

Resume a stale 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 via crontab

Fields

action: ScheduleAction

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