Struct Command 

pub struct Command { /* private fields */ }

One slash-command palette entry completed by SlashCommands.

Implementations

impl Command

pub fn new(name: &str, description: &str, aliases: &[&str]) -> Self

Builds a palette entry from its name, blurb, and alias spellings.

Examples found in repository

examples/chat/demo.rs (lines 136-140)

pub fn demo_commands() -> Vec<Command> {
	vec![
		Command::new(
			"security",
			"Plan, run, inspect, import, and compare OMP-native security scans",
			&[],
		)
		.with_args(&[
			("plan", "Draft a scan plan for this workspace", "[focus]"),
			("run", "Execute the current scan plan", ""),
			("inspect", "Browse findings from the last scan", "[finding-id]"),
			("import", "Import an external scan report", "<path>"),
			("compare", "Diff two scan runs", "<run-a> <run-b>"),
		])
		.with_hint("plan|run|inspect|import|compare"),
		Command::new("attach", "Stage an image attachment on the composer", &[]).with_hint("<path>"),
		Command::new("settings", "Open settings menu", &[]),
		Command::new("setup", "Open provider setup", &["providers"]).with_hint("[provider]"),
		Command::new("plan", "Toggle plan mode (agent plans before executing)", &[]),
		Command::new("plan-review", "Re-open the plan review for the latest plan", &[]),
		Command::new("vibe", "Toggle persistent fast worker sessions", &[]),
		Command::new("goal", "Toggle an autonomous objective for this session", &[])
			.with_hint("<objective>"),
		Command::new("guided-goal", "Interview you in chat, then set up goal mode", &[]),
		Command::new("queue", "Queue a message for after the agent yields", &[]),
		Command::new("switch", "Switch model for this session (same as alt+p)", &[]),
		Command::new("fast", "Toggle priority service tier", &[]),
		Command::new("computer", "Toggle the native computer-use tool", &[]),
		Command::new("vision", "Control inspect_image vision delegation", &[]),
		Command::new("prewalk", "Switch to a fast model at the next action", &[]),
		Command::new("advisor", "Toggle the second-model advisor", &[]),
		Command::new("export", "Export session to an HTML file", &[]),
		Command::new("dump", "Copy the session transcript to clipboard", &[]),
		Command::new("share", "Share session via an encrypted link", &[]),
		Command::new("collab", "Share this session live via a relay", &[]),
		Command::new("join", "Join a shared collab session", &[]),
		Command::new("leave", "Leave the collab session", &[]),
		Command::new("browser", "Toggle browser headless vs visible mode", &[]),
		Command::new("copy", "Pick conversation text or code to copy", &[]),
		Command::new("todo", "View or modify the agent's todo list", &[]),
		Command::new("session", "Session management commands", &[]),
		Command::new("jobs", "Show async background jobs status", &[]),
		Command::new("usage", "Show provider usage and limits", &[]),
		Command::new("stats", "Launch the local stats dashboard", &[]),
		Command::new("changelog", "Show changelog entries", &[]),
		Command::new("hotkeys", "Show all keyboard shortcuts", &[]),
		Command::new("tools", "Show tools currently visible to the agent", &[]),
		Command::new("context", "Show estimated context usage breakdown", &[]),
		Command::new("agents", "Open Agent Control Center dashboard", &[]),
		Command::new("branch", "Create a new branch from a previous message", &[]),
		Command::new("fork", "Create a new fork from a previous message", &[]),
		Command::new("tree", "Navigate the session tree", &[]),
		Command::new("login", "Login with an OAuth provider", &[]),
		Command::new("logout", "Logout from an OAuth provider", &[]),
		Command::new("mcp", "Manage MCP servers", &[]),
		Command::new("ssh", "Manage SSH hosts", &[]),
		Command::new("new", "Start a new session", &[]),
		Command::new("fresh", "Reset provider state without changing the transcript", &[]),
		Command::new("clear", "Clear conversation context, keeping the session", &[]),
		Command::new("drop", "Delete the current session and start a new one", &[]),
		Command::new("compact", "Manually compact the session context", &[]),
		Command::new("shake", "Drop heavy content from context", &[]),
		Command::new("handoff", "Hand off context to a new session", &[]),
		Command::new("resume", "Resume a different session", &[]),
		Command::new("btw", "Ask an ephemeral side question", &[]),
		Command::new("tan", "Run a background agent on tangential work", &[]),
		Command::new("omfg", "Forge a rule from a recurring complaint", &[]),
		Command::new("retry", "Retry the last failed agent turn", &[]),
		Command::new("debug", "Open the debug tools selector", &[]),
		Command::new("memory", "Inspect and operate memory maintenance", &[]),
		Command::new("rename", "Rename the current session", &[]),
		Command::new("move", "Move the session to a different directory", &[]),
		Command::new("add-dir", "Add a workspace directory", &[]),
		Command::new("remove-dir", "Remove a workspace directory", &[]),
		Command::new("dirs", "List this session's workspace directories", &[]),
		Command::new("marketplace", "Manage marketplace plugins", &[]),
		Command::new("plugins", "View and manage installed plugins", &[]),
		Command::new("reload-plugins", "Reload skills, commands, hooks, tools, and agents", &[]),
		Command::new("force", "Force the next turn to use a specific tool", &["force:"]),
		Command::new("live", "Start Codex-backed realtime voice mode", &[]),
		Command::new("pause", "Freeze all agents until resumed", &[]),
		Command::new("quit", "Quit the application", &["q"]),
	]
}

pub fn with_args(self, args: &[(&str, &str, &str)]) -> Self

Argument candidates offered once the command name is complete: (name, description, usage), with "" usage meaning none. Usage text ghosts after the argument pi-style (<path>, <a> <b>).

Examples found in repository

examples/chat/demo.rs (lines 141-147)

pub fn demo_commands() -> Vec<Command> {
	vec![
		Command::new(
			"security",
			"Plan, run, inspect, import, and compare OMP-native security scans",
			&[],
		)
		.with_args(&[
			("plan", "Draft a scan plan for this workspace", "[focus]"),
			("run", "Execute the current scan plan", ""),
			("inspect", "Browse findings from the last scan", "[finding-id]"),
			("import", "Import an external scan report", "<path>"),
			("compare", "Diff two scan runs", "<run-a> <run-b>"),
		])
		.with_hint("plan|run|inspect|import|compare"),
		Command::new("attach", "Stage an image attachment on the composer", &[]).with_hint("<path>"),
		Command::new("settings", "Open settings menu", &[]),
		Command::new("setup", "Open provider setup", &["providers"]).with_hint("[provider]"),
		Command::new("plan", "Toggle plan mode (agent plans before executing)", &[]),
		Command::new("plan-review", "Re-open the plan review for the latest plan", &[]),
		Command::new("vibe", "Toggle persistent fast worker sessions", &[]),
		Command::new("goal", "Toggle an autonomous objective for this session", &[])
			.with_hint("<objective>"),
		Command::new("guided-goal", "Interview you in chat, then set up goal mode", &[]),
		Command::new("queue", "Queue a message for after the agent yields", &[]),
		Command::new("switch", "Switch model for this session (same as alt+p)", &[]),
		Command::new("fast", "Toggle priority service tier", &[]),
		Command::new("computer", "Toggle the native computer-use tool", &[]),
		Command::new("vision", "Control inspect_image vision delegation", &[]),
		Command::new("prewalk", "Switch to a fast model at the next action", &[]),
		Command::new("advisor", "Toggle the second-model advisor", &[]),
		Command::new("export", "Export session to an HTML file", &[]),
		Command::new("dump", "Copy the session transcript to clipboard", &[]),
		Command::new("share", "Share session via an encrypted link", &[]),
		Command::new("collab", "Share this session live via a relay", &[]),
		Command::new("join", "Join a shared collab session", &[]),
		Command::new("leave", "Leave the collab session", &[]),
		Command::new("browser", "Toggle browser headless vs visible mode", &[]),
		Command::new("copy", "Pick conversation text or code to copy", &[]),
		Command::new("todo", "View or modify the agent's todo list", &[]),
		Command::new("session", "Session management commands", &[]),
		Command::new("jobs", "Show async background jobs status", &[]),
		Command::new("usage", "Show provider usage and limits", &[]),
		Command::new("stats", "Launch the local stats dashboard", &[]),
		Command::new("changelog", "Show changelog entries", &[]),
		Command::new("hotkeys", "Show all keyboard shortcuts", &[]),
		Command::new("tools", "Show tools currently visible to the agent", &[]),
		Command::new("context", "Show estimated context usage breakdown", &[]),
		Command::new("agents", "Open Agent Control Center dashboard", &[]),
		Command::new("branch", "Create a new branch from a previous message", &[]),
		Command::new("fork", "Create a new fork from a previous message", &[]),
		Command::new("tree", "Navigate the session tree", &[]),
		Command::new("login", "Login with an OAuth provider", &[]),
		Command::new("logout", "Logout from an OAuth provider", &[]),
		Command::new("mcp", "Manage MCP servers", &[]),
		Command::new("ssh", "Manage SSH hosts", &[]),
		Command::new("new", "Start a new session", &[]),
		Command::new("fresh", "Reset provider state without changing the transcript", &[]),
		Command::new("clear", "Clear conversation context, keeping the session", &[]),
		Command::new("drop", "Delete the current session and start a new one", &[]),
		Command::new("compact", "Manually compact the session context", &[]),
		Command::new("shake", "Drop heavy content from context", &[]),
		Command::new("handoff", "Hand off context to a new session", &[]),
		Command::new("resume", "Resume a different session", &[]),
		Command::new("btw", "Ask an ephemeral side question", &[]),
		Command::new("tan", "Run a background agent on tangential work", &[]),
		Command::new("omfg", "Forge a rule from a recurring complaint", &[]),
		Command::new("retry", "Retry the last failed agent turn", &[]),
		Command::new("debug", "Open the debug tools selector", &[]),
		Command::new("memory", "Inspect and operate memory maintenance", &[]),
		Command::new("rename", "Rename the current session", &[]),
		Command::new("move", "Move the session to a different directory", &[]),
		Command::new("add-dir", "Add a workspace directory", &[]),
		Command::new("remove-dir", "Remove a workspace directory", &[]),
		Command::new("dirs", "List this session's workspace directories", &[]),
		Command::new("marketplace", "Manage marketplace plugins", &[]),
		Command::new("plugins", "View and manage installed plugins", &[]),
		Command::new("reload-plugins", "Reload skills, commands, hooks, tools, and agents", &[]),
		Command::new("force", "Force the next turn to use a specific tool", &["force:"]),
		Command::new("live", "Start Codex-backed realtime voice mode", &[]),
		Command::new("pause", "Freeze all agents until resumed", &[]),
		Command::new("quit", "Quit the application", &["q"]),
	]
}

pub fn with_hint(self, hint: &str) -> Self

Usage hint shown as dim ghost text after the cursor, pi-style (e.g. <name> [--scope project|user]).

Examples found in repository

examples/chat/demo.rs (line 148)

pub fn demo_commands() -> Vec<Command> {
	vec![
		Command::new(
			"security",
			"Plan, run, inspect, import, and compare OMP-native security scans",
			&[],
		)
		.with_args(&[
			("plan", "Draft a scan plan for this workspace", "[focus]"),
			("run", "Execute the current scan plan", ""),
			("inspect", "Browse findings from the last scan", "[finding-id]"),
			("import", "Import an external scan report", "<path>"),
			("compare", "Diff two scan runs", "<run-a> <run-b>"),
		])
		.with_hint("plan|run|inspect|import|compare"),
		Command::new("attach", "Stage an image attachment on the composer", &[]).with_hint("<path>"),
		Command::new("settings", "Open settings menu", &[]),
		Command::new("setup", "Open provider setup", &["providers"]).with_hint("[provider]"),
		Command::new("plan", "Toggle plan mode (agent plans before executing)", &[]),
		Command::new("plan-review", "Re-open the plan review for the latest plan", &[]),
		Command::new("vibe", "Toggle persistent fast worker sessions", &[]),
		Command::new("goal", "Toggle an autonomous objective for this session", &[])
			.with_hint("<objective>"),
		Command::new("guided-goal", "Interview you in chat, then set up goal mode", &[]),
		Command::new("queue", "Queue a message for after the agent yields", &[]),
		Command::new("switch", "Switch model for this session (same as alt+p)", &[]),
		Command::new("fast", "Toggle priority service tier", &[]),
		Command::new("computer", "Toggle the native computer-use tool", &[]),
		Command::new("vision", "Control inspect_image vision delegation", &[]),
		Command::new("prewalk", "Switch to a fast model at the next action", &[]),
		Command::new("advisor", "Toggle the second-model advisor", &[]),
		Command::new("export", "Export session to an HTML file", &[]),
		Command::new("dump", "Copy the session transcript to clipboard", &[]),
		Command::new("share", "Share session via an encrypted link", &[]),
		Command::new("collab", "Share this session live via a relay", &[]),
		Command::new("join", "Join a shared collab session", &[]),
		Command::new("leave", "Leave the collab session", &[]),
		Command::new("browser", "Toggle browser headless vs visible mode", &[]),
		Command::new("copy", "Pick conversation text or code to copy", &[]),
		Command::new("todo", "View or modify the agent's todo list", &[]),
		Command::new("session", "Session management commands", &[]),
		Command::new("jobs", "Show async background jobs status", &[]),
		Command::new("usage", "Show provider usage and limits", &[]),
		Command::new("stats", "Launch the local stats dashboard", &[]),
		Command::new("changelog", "Show changelog entries", &[]),
		Command::new("hotkeys", "Show all keyboard shortcuts", &[]),
		Command::new("tools", "Show tools currently visible to the agent", &[]),
		Command::new("context", "Show estimated context usage breakdown", &[]),
		Command::new("agents", "Open Agent Control Center dashboard", &[]),
		Command::new("branch", "Create a new branch from a previous message", &[]),
		Command::new("fork", "Create a new fork from a previous message", &[]),
		Command::new("tree", "Navigate the session tree", &[]),
		Command::new("login", "Login with an OAuth provider", &[]),
		Command::new("logout", "Logout from an OAuth provider", &[]),
		Command::new("mcp", "Manage MCP servers", &[]),
		Command::new("ssh", "Manage SSH hosts", &[]),
		Command::new("new", "Start a new session", &[]),
		Command::new("fresh", "Reset provider state without changing the transcript", &[]),
		Command::new("clear", "Clear conversation context, keeping the session", &[]),
		Command::new("drop", "Delete the current session and start a new one", &[]),
		Command::new("compact", "Manually compact the session context", &[]),
		Command::new("shake", "Drop heavy content from context", &[]),
		Command::new("handoff", "Hand off context to a new session", &[]),
		Command::new("resume", "Resume a different session", &[]),
		Command::new("btw", "Ask an ephemeral side question", &[]),
		Command::new("tan", "Run a background agent on tangential work", &[]),
		Command::new("omfg", "Forge a rule from a recurring complaint", &[]),
		Command::new("retry", "Retry the last failed agent turn", &[]),
		Command::new("debug", "Open the debug tools selector", &[]),
		Command::new("memory", "Inspect and operate memory maintenance", &[]),
		Command::new("rename", "Rename the current session", &[]),
		Command::new("move", "Move the session to a different directory", &[]),
		Command::new("add-dir", "Add a workspace directory", &[]),
		Command::new("remove-dir", "Remove a workspace directory", &[]),
		Command::new("dirs", "List this session's workspace directories", &[]),
		Command::new("marketplace", "Manage marketplace plugins", &[]),
		Command::new("plugins", "View and manage installed plugins", &[]),
		Command::new("reload-plugins", "Reload skills, commands, hooks, tools, and agents", &[]),
		Command::new("force", "Force the next turn to use a specific tool", &["force:"]),
		Command::new("live", "Start Codex-backed realtime voice mode", &[]),
		Command::new("pause", "Freeze all agents until resumed", &[]),
		Command::new("quit", "Quit the application", &["q"]),
	]
}

pub fn name(&self) -> &str

The command’s primary spelling, without the leading /.

Examples found in repository

examples/chat/commands.rs (line 194)

fn entries() -> Vec<EntrySpec> {
	let commands = demo_commands();
	let mut list = Vec::with_capacity(commands.len() + 3);
	list.push(EntrySpec::action(
		SWITCH_MODEL,
		"Switch Model",
		"Pick the model for this session",
		"ctrl+p",
	));
	list.push(EntrySpec::action(
		TOGGLE_SIDEBAR,
		"Toggle Sidebar",
		"Show or hide the session rail",
		"ctrl+b",
	));
	list.push(EntrySpec::action(QUIT, "Quit", "Exit the demo", "ctrl+c"));
	list.extend(commands.iter().map(|command| {
		let name = fmts!("/{}", command.name());
		EntrySpec {
			value: name.clone(),
			label: name.clone(),
			name,
			name_fg: CYAN,
			detail: Str::from(command.description()),
			key: Str::default(),
		}
	}));
	list
}

pub fn description(&self) -> &str

The one-line blurb shown beside the command name.

Examples found in repository

examples/chat/commands.rs (line 200)

fn entries() -> Vec<EntrySpec> {
	let commands = demo_commands();
	let mut list = Vec::with_capacity(commands.len() + 3);
	list.push(EntrySpec::action(
		SWITCH_MODEL,
		"Switch Model",
		"Pick the model for this session",
		"ctrl+p",
	));
	list.push(EntrySpec::action(
		TOGGLE_SIDEBAR,
		"Toggle Sidebar",
		"Show or hide the session rail",
		"ctrl+b",
	));
	list.push(EntrySpec::action(QUIT, "Quit", "Exit the demo", "ctrl+c"));
	list.extend(commands.iter().map(|command| {
		let name = fmts!("/{}", command.name());
		EntrySpec {
			value: name.clone(),
			label: name.clone(),
			name,
			name_fg: CYAN,
			detail: Str::from(command.description()),
			key: Str::default(),
		}
	}));
	list
}

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.