Enum Commands 

pub enum Commands {
    Init,
    List,
    Models,
    ModelInfo {
        model: String,
    },
    Chat,
    Version,
    Update {
        check: bool,
        force: bool,
    },
    Status,
    Doctor {
        format: OutputFormat,
    },
    SelfTest {
        format: OutputFormat,
        keep_workspace: bool,
    },
    Tasks {
        limit: usize,
    },
    Task {
        id: String,
    },
    Processes {
        limit: usize,
    },
    Logs {
        id: String,
    },
    Stop {
        id: String,
    },
    Restart {
        id: String,
    },
    Open {
        target: String,
    },
    Ports,
    Approvals,
    Approve {
        id: String,
    },
    Deny {
        id: String,
    },
    ToolRuns {
        limit: usize,
    },
    Checkpoints {
        limit: usize,
    },
    Restore {
        id: String,
        force: bool,
    },
    Plugin {
        command: PluginCommand,
    },
    Daemon {
        command: DaemonCommand,
    },
    Pair {
        command: PairCommand,
    },
    Qa {
        command: QaCommand,
    },
    Add {
        name: String,
        yes: bool,
    },
    Remove {
        name: String,
    },
    Mcp,
    Pr {
        command: PrCommand,
    },
    CloudSetup,
    Run {
        prompt: String,
        format: OutputFormat,
        max_tokens: Option<usize>,
        no_execute: bool,
        allow_untrusted_tools: bool,
    },
}

Variants

Init

Initialize configuration

List

List available models

Models

List model/provider capability records

ModelInfo

Show static and cached capability info for a model id

Fields

model: String

Model id, e.g. /

Chat

Start a chat session (default)

Version

Show version information

Update

Update Mermaid to the latest release

Fields

check: bool

Only report whether an update is available; don’t install it

force: bool

Reinstall even if already on the latest version

Status

Check status of dependencies and backends

Doctor

Check first-run readiness and explain what Mermaid can do now

Fields

format: OutputFormat

Output format (text, json, markdown)

SelfTest

Run fast deterministic Mermaid self-tests

Fields

format: OutputFormat

Output format (text, json, markdown)

keep_workspace: bool

Keep the temporary self-test workspace after the run

Tasks

List durable runtime tasks

Fields

limit: usize

Maximum number of tasks to show

Task

Show one durable runtime task and its timeline

Fields

id: String

Task id

Processes

List Mermaid-managed background processes

Fields

limit: usize

Maximum number of processes to show

Logs

Print a managed process log

Fields

id: String

Process id from mermaid processes

Stop

Stop a managed process

Fields

id: String

Process id from mermaid processes

Restart

Restart a managed process

Fields

id: String

Process id from mermaid processes

Open

Open a URL, file, or managed process URL

Fields

target: String

URL, path, or process id

Ports

Show listening TCP ports

Approvals

List pending approvals

Approve

Approve a pending approval record

Fields

id: String

Approval id

Deny

Deny a pending approval record

Fields

id: String

Approval id

ToolRuns

List recent persisted tool runs

Fields

limit: usize

Maximum number of tool runs to show

Checkpoints

List checkpoints

Fields

limit: usize

Maximum number of checkpoints to show

Restore

Restore a checkpoint by id

Fields

id: String

Checkpoint id

force: bool

Skip the confirmation prompt (required for non-interactive use)

Plugin

Manage Mermaid plugin bundles

Fields

command: PluginCommand

Daemon

Manage Mermaid’s Linux background service

Fields

command: DaemonCommand

Pair

Manage remote pairing tokens

Fields

command: PairCommand

Qa

Internal self-QA commands. Hidden from normal help output.

Fields

command: QaCommand

Add

Add an MCP server (e.g., mermaid add context7)

Fields

name: String

MCP server name (e.g., context7, git, filesystem)

yes: bool

Skip the confirmation prompt before fetching and running a package that is not in the built-in registry (for scripted/CI use). Without this, adding an unknown package fails closed when there is no TTY.

Remove

Remove a configured MCP server

Fields

name: String

MCP server name to remove

Mcp

List configured MCP servers

Pr

Create a pull/merge request from the current branch via the host CLI (gh for GitHub, glab for GitLab)

Fields

command: PrCommand

CloudSetup

Configure Ollama Cloud API key (interactive prompt). Run this from your shell before starting mermaid — it reads stdin and doesn’t work from inside the TUI.

Run

Run a single prompt non-interactively

Fields

prompt: String

The prompt to execute

format: OutputFormat

Output format (text, json, markdown)

max_tokens: Option<usize>

Maximum tokens to generate

no_execute: bool

Don’t execute agent actions (dry run)

allow_untrusted_tools: bool

Allow non-replayable tools (web/mcp/subagent/computer-use) to run on an Ask decision in this headless run. Off by default — ask mode otherwise refuses them when there’s no approval UI.

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