Skip to main content

Commands

Enum Commands 

Source
pub enum Commands {
Show 39 variants Run { task: String, json: bool, }, Plan { task: String, json: bool, }, Chat, Tui, Launch { port: u16, tui: bool, }, Console { port: u16, }, Daemon, Agent { action: AgentAction, }, Swarm { task: String, }, Schedule { task: String, cron: String, autonomy: Option<String>, report: Vec<String>, }, Model { set: Option<String>, list: bool, }, Route { action: RouteAction, }, Auth { action: AuthAction, }, Skills { action: SkillsAction, }, Plugins { action: PluginsAction, }, Tools { action: ToolsAction, }, Security { action: SecurityAction, }, Github { action: GithubAction, }, Compact { task: Option<String>, out: Option<PathBuf>, json: bool, }, Mcp { action: McpAction, }, Checkpoint { action: CheckpointAction, }, Rewind { id: String, }, Replay { run_id: String, scrub: bool, }, Gateway { action: GatewayAction, }, Sessions { action: SessionAction, }, Learn, Init, Status, Memory { action: MemoryAction, }, Permissions { action: PermissionAction, }, Profile { action: ProfileAction, }, Import { source: ImportSource, }, Config { edit: bool, }, Update, Doctor, Setup, Demo, Share, Hook { action: HookAction, },
}

Variants§

§

Run

Run a single agentic task

Fields

§task: String

Task description

§json: bool

Emit NDJSON event stream (same as the global –json flag, but may follow the task: sparrow run "..." --json)

§

Plan

Create a read-only execution plan for a task

Fields

§task: String

Task description

§json: bool

Emit JSON instead of Markdown

§

Chat

Interactive multi-turn chat

§

Tui

Launch TUI

§

Launch

Launch first-run setup, then the WebView cockpit

Fields

§port: u16

TCP port for the WebView HTTP/WS server

§tui: bool

Launch the terminal TUI instead of the WebView cockpit

§

Console

Launch webview console (HTTP + WebSocket)

Fields

§port: u16

TCP port for the webview HTTP/WS server

§

Daemon

Run headless Sparrow runtime daemon

§

Agent

Manage persistent agents

Fields

§

Swarm

Run swarm: planner → coder → verifier

Fields

§task: String

Task or plan file

§

Schedule

Schedule periodic jobs

Fields

§task: String

Task description

§cron: String

Cron expression

§autonomy: Option<String>

Autonomy level for scheduled jobs

§report: Vec<String>

Report to surfaces

§

Model

Manage model routing

Fields

§set: Option<String>

Set active route

§list: bool

List available models

§

Route

Configure intelligent auto-routing provider

Fields

§

Auth

Manage provider credentials

Fields

§action: AuthAction
§

Skills

Manage skill library

Fields

§

Plugins

Manage local Sparrow plugins

Fields

§

Tools

Inspect and gate toolsets

Fields

§

Security

Security audit of config, permissions, plugins, hooks, secrets

Fields

§

Github

GitHub Action / remote PR workflow

Fields

§

Compact

Compact context and write a durable handoff doc

Fields

§task: Option<String>

Task description (recorded in the handoff)

§out: Option<PathBuf>

Output path (default: .sparrow/handoff/.md)

§json: bool

Emit JSON instead of Markdown to stdout (the file is always Markdown)

§

Mcp

Manage MCP connectors

Fields

§action: McpAction
§

Checkpoint

List checkpoints

Fields

§

Rewind

Rewind to a checkpoint

Fields

§id: String

Checkpoint ID or number

§

Replay

Replay a transcript

Fields

§run_id: String

Run ID to replay

§scrub: bool

Open an interactive TUI scrubber (←/→ to step through events)

§

Gateway

Start/stop gateway daemon

Fields

§

Sessions

Manage saved sessions

Fields

§

Learn

Interactive tutorial

§

Init

Initialize a project with .sparrow/ config

§

Status

Show live status (active runs, budget, session)

§

Memory

Manage persistent memory

Fields

§

Permissions

Inspect and update permission policy

Fields

§

Profile

Profile management

Fields

§

Import

Migrate from OpenClaw

Fields

§

Config

Edit configuration

Fields

§edit: bool

Open config.toml in editor

§

Update

Self-update

§

Doctor

Run diagnostics

§

Setup

(Re)run conversational setup

§

Demo

Run a self-contained demo (snake game)

§

Share

Share latest session as GitHub Gist

§

Hook

Install or scan security pre-commit hooks

Fields

§action: HookAction

Trait Implementations§

Source§

impl FromArgMatches for Commands

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 Commands

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more