Enum Command 

pub enum Command {
    RetiredHook {
        sub: &'static str,
    },
    Serve {
        db_dir: PathBuf,
        addr: SocketAddr,
        ui: ServeUi,
        demo_if_empty: bool,
        token: Option<String>,
        role_tokens: Vec<(String, String)>,
        snapshot_every: Option<Duration>,
        restore_from: Option<PathBuf>,
        tls_cert: Option<PathBuf>,
        tls_key: Option<PathBuf>,
    },
    Mcp {
        db_dir: Option<PathBuf>,
        auto: bool,
        all_tools: bool,
    },
    Stats {
        db_dir: PathBuf,
    },
    Demo {
        db_dir: PathBuf,
    },
    AsOf {
        db_dir: PathBuf,
        commit: Option<u64>,
        at: Option<String>,
        query: Option<String>,
        namespace: Option<String>,
    },
    Suggest {
        db_dir: PathBuf,
    },
    Algo {
        db_dir: PathBuf,
        subcmd: AlgoSubcmd,
        top: usize,
        dir: AlgoDir,
        edge_types: Vec<String>,
        weight_prop: Option<String>,
        min_weight: Option<f64>,
    },
    Query {
        db_dir: PathBuf,
        cypher: String,
        role: Option<String>,
        namespace: Option<String>,
    },
    Snapshot {
        db_dir: PathBuf,
        wal: WalDisposition,
        retention: Option<u32>,
    },
    BuildIndex {
        db_dir: PathBuf,
        rule: Option<String>,
    },
    SchemaApply {
        db_dir: PathBuf,
        schema_file: Option<PathBuf>,
        memory_defaults: bool,
        memory_identity: bool,
    },
    Migrate {
        db_dir: PathBuf,
    },
    Verify {
        db_dir: PathBuf,
    },
    Backup {
        db_dir: PathBuf,
        dest: PathBuf,
    },
    Export {
        db_dir: PathBuf,
        dest: PathBuf,
        format: ExportFormat,
    },
    IngestGit {
        db_dir: PathBuf,
        opts: IngestGitOpts,
    },
    Install(InstallOpts),
    Uninstall(InstallOpts),
    Disable(ToggleOpts),
    Enable(ToggleOpts),
    Doctor(DoctorOpts),
    Recall {
        db_dir: Option<PathBuf>,
        auto: bool,
    },
    Brief {
        db_dir: Option<PathBuf>,
        auto: bool,
    },
    Why {
        db_dir: PathBuf,
        a: String,
        b: String,
    },
    Version,
    Help,
}

Parsed mushroomdb invocation.

No Eq derive: Algo { min_weight: Option<f64>, .. } carries a float.

Variants

RetiredHook

A hook body 0.6 installed and 0.7 retired: touch, intercept, impact-hook and enrich in the assistant’s settings, sync in the git hooks. A machine that upgraded without re-running install still calls them, so each is accepted with any arguments, opens nothing, and prints one stderr line saying how to remove it. Never in usage.

Fields

sub: &'static str

Serve

Fields

db_dir: PathBuf

addr: SocketAddr

ui: ServeUi

demo_if_empty: bool

If the db dir is missing or empty, run run_demo before serving. Docker’s default CMD uses this so a fresh volume is ready on first boot.

token: Option<String>

Bearer token for non-loopback binds. Loopback may omit it.

role_tokens: Vec<(String, String)>

Role-bound tokens from --role-token TOKEN:ROLE flags. Merged with MUSHROOMDB_ROLE_TOKENS env var in main before serving.

snapshot_every: Option<Duration>

Periodic snapshot cadence. None = off (default).

restore_from: Option<PathBuf>

Seed an empty db_dir from the newest backup under this directory before opening it. See restore_if_empty. None = off (default).

tls_cert: Option<PathBuf>

Path to PEM certificate for native TLS (--tls-cert). Requires --tls-key.

tls_key: Option<PathBuf>

Path to PEM private key for native TLS (--tls-key). Requires --tls-cert.

Mcp

Fields

db_dir: Option<PathBuf>

None with auto set: resolved by resolve_auto_db at run time.

auto: bool

all_tools: bool

--all-tools: advertise every served tool in tools/list rather than the association tools every store lists by default. The rest are callable either way; the flag decides what is listed, and what every session pays for before its first turn.

Stats

Fields

db_dir: PathBuf

Demo

Fields

db_dir: PathBuf

AsOf

Read-only view of the database at a past commit.

Fields

db_dir: PathBuf

commit: Option<u64>

0-based WAL commit index to replay up to (inclusive).

Exactly one of commit and at is set — the parser refuses both and refuses neither, because a precedence rule between them is how a caller ends up believing it asked for a date while the engine answered a commit.

at: Option<String>

RFC 3339 date to replay up to, resolved against the store’s recorded commit times once it is open.

query: Option<String>

Optional Cypher read query to execute against the as-of view.

namespace: Option<String>

Read only this namespace, as it was at that commit.

Suggest

Profile the database and suggest linking rules with estimated edge counts.

Fields

db_dir: PathBuf

Algo

Run a graph algorithm (pagerank / wcc / degree / communities).

Fields

db_dir: PathBuf

subcmd: AlgoSubcmd

top: usize

Print only the top N results (0 = all).

dir: AlgoDir

Edge direction for degree/pagerank (out / in / both). Ignored by wcc and communities, which are always undirected.

edge_types: Vec<String>

communities only: restrict to the union of these edge types (--edge-type T, repeatable). Empty means all edge types.

weight_prop: Option<String>

communities only: edge property to read as the edge weight.

min_weight: Option<f64>

communities only: drop edges below this resolved weight.

Query

Run a Cypher query (read or write).

Fields

db_dir: PathBuf

cypher: String

Positional after dir (remaining args joined), or --query.

role: Option<String>

Answer as one of the store’s roles: only the nodes it may see.

namespace: Option<String>

Answer from one namespace only. Intersects role — never widens it.

Snapshot

Write snapshot.bin. The WAL is archived unless told otherwise.

Fields

db_dir: PathBuf

wal: WalDisposition

retention: Option<u32>

Keep the newest N archives; prune oldest at snapshot time. None = unlimited. Applies only when the WAL is archived.

BuildIndex

Drive any outstanding vector-index build to completion.

Fields

db_dir: PathBuf

rule: Option<String>

Build only this rule; None builds every pending one.

SchemaApply

Apply a JSON schema file idempotently (schema apply <db-dir> <schema.json>), the built-in memory schema (schema apply <db-dir> --memory-defaults), or the identity preset (schema apply <db-dir> --memory-identity).

Fields

db_dir: PathBuf

schema_file: Option<PathBuf>

None when a built-in was named instead.

memory_defaults: bool

memory_identity: bool

Migrate

Migrate an old-format snapshot to the current version and keep .bak.

Fields

db_dir: PathBuf

Verify

Validate CRC32 integrity of every section in the V8 snapshot.

Fields

db_dir: PathBuf

Backup

Create a consistent, verified copy of the database directory.

Fields

db_dir: PathBuf

dest: PathBuf

Export

Export all nodes, edges, and rules to a destination directory.

Fields

db_dir: PathBuf

dest: PathBuf

format: ExportFormat

IngestGit

Build (or incrementally sync) a graph of a git repository.

Fields

db_dir: PathBuf

opts: IngestGitOpts

Install(InstallOpts)

Wire the /mushroom skill and MCP server into Claude Code / Cursor.

Uninstall(InstallOpts)

Undo what install wrote (manifest-driven).

Disable(ToggleOpts)

Turn an install off without removing it: strips the hooks, the MCP entry and the git hook blocks; the skill, the store and the .gitignore line stay.

Enable(ToggleOpts)

Turn a disabled install back on, re-deriving the dynamic parts (the resolved command, the hooks) rather than replaying stale ones.

Doctor(DoctorOpts)

Verify an install end to end: config, store, hooks, and a real MCP handshake.

Recall

Body of the Claude Code UserPromptSubmit hook: reads a prompt payload on stdin, prints related graph facts on stdout.

Fields

db_dir: Option<PathBuf>

auto: bool

Brief

Body of the Claude Code SessionStart hook: prints the repository in one byte-stable block, which the host caches for the whole session.

Fields

db_dir: Option<PathBuf>

auto: bool

Why

What links two nodes, with the evidence behind each link.

Fields

db_dir: PathBuf

a: String

b: String

Version

Help

Trait Implementations

impl Clone for Command

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Command

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Command