Struct CommandSpec 

pub struct CommandSpec {
    pub id: SharedString,
    pub title: SharedString,
    pub icon: IconName,
    pub hint: SharedString,
    pub group: SharedString,
    pub key: Option<SharedString>,
    pub args: Option<Value>,
    pub read_only: bool,
    pub enabled: EnabledFn,
    pub checked: Option<CheckedFn>,
    pub run: RunFn,
}

One thing an app can do.

Fields

id: SharedString

Unique, dotted by area: file.open, hist.find_cells, pipeline.add_op.

title: SharedString

What menus and search show: “Open image…”.

icon: IconName

Its icon, in menus and search.

hint: SharedString

One line saying what it does (search, tooltips, the agent’s tool description).

group: SharedString

The group it is listed under in search (“File”, “Process”).

key: Option<SharedString>

Its key in GPUI’s notation (secondary-o: Cmd on macOS, Ctrl elsewhere), if any.

args: Option<Value>

The JSON Schema of its arguments, when an agent can pass some (CommandSpec::with_args).

read_only: bool

Whether it only reads (an agent may run it without asking).

enabled: EnabledFn

Whether it can run now, and why not.

checked: Option<CheckedFn>

For a toggle: whether it is on.

run: RunFn

What it does.

Implementations

impl CommandSpec

pub fn new( id: impl Into<SharedString>, title: impl Into<SharedString>, icon: IconName, run: impl Fn(&mut Window, &mut App) + 'static, ) -> Self

A plain command: no arguments, no result.

pub fn with_args<A: DeserializeOwned + JsonSchema + 'static>( id: impl Into<SharedString>, title: impl Into<SharedString>, icon: IconName, run: impl Fn(A, &mut Window, &mut App) -> Result<Value, String> + 'static, ) -> Self

A command taking arguments A (their JSON Schema comes from A, and a call whose arguments do not read as A is refused with the reason) and returning JSON.

pub fn raw( id: impl Into<SharedString>, title: impl Into<SharedString>, icon: IconName, args: Option<Value>, run: RunFn, ) -> Self

A command from its parts: args is its JSON Schema (or None), run gets the raw JSON.

pub fn hint(self, hint: impl Into<SharedString>) -> Self

Sets the line saying what it does.

pub fn group(self, group: impl Into<SharedString>) -> Self

Sets the group it is listed under.

pub fn key(self, key: impl Into<SharedString>) -> Self

Sets its key (secondary-o, f3, secondary-shift-s).

pub fn read_only(self) -> Self

Marks it as only reading (an agent may run it without asking).

pub fn enabled( self, enabled: impl Fn(&App) -> Result<(), String> + 'static, ) -> Self

Sets when it can run (Err(why) otherwise).

pub fn checked(self, checked: impl Fn(&App) -> bool + 'static) -> Self

Makes it a toggle, on when checked says so.

pub fn key_label(&self) -> Option<String>

Its key as people read it (“Ctrl+Shift+S”, “⌘⇧S” on macOS).

Trait Implementations

impl Clone for CommandSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.