Crate cli 

mushroomdb CLI library: hand-rolled arg parsing and the demo dataset builder.

The binary in main.rs stays thin — it dispatches on parse_args and prints what the lib functions return.

Modules

doctor

mushroomdb doctor — verify an install end to end: the config entry, the store, the hooks, and a real stdio handshake with the configured MCP command.

export

Export writer for mushroomdb export.

import

mushroomdb import: bulk load of a nodes CSV and a relationships CSV.

ingest_git

mushroomdb ingest-git <db> <repo>: build and maintain a graph of a git repository. First run ingests the whole history; later runs apply only the commits after the recorded GitSync head, so deletes and renames retract or move derived edges instead of leaving them stale.

install

mushroomdb install / uninstall — wire the /mushroom skill, the MCP server and the session hooks into an assistant.

recall

mushroomdb recall <db>: the body of the UserPromptSubmit hook.

serve_bolt

serve’s Bolt listener settings: the --bolt-* flags, their environment variables, and the rules that turn them into a listener config or refuse the start.

structure

Structure ingest: the working tree, read as graph.

Structs

CliError

CLI-facing error. [Display] is the message printed to stderr.

DemoOutcome

Outcome of run_demo. Counts are deterministic.

ShutdownPlan

How a shutdown’s time is divided: the three phases, in order, and the most each may take. They sum to at most the timeout.

TxFlags

The HTTP transaction limits as given on serve’s command line; None is “not given”, which leaves the environment variable (or the default) in force. Non-zero integers, not Durations, keep Command::Serve small.

Enums

AlgoSubcmd

Algorithm subcommand for mushroomdb algo.

Command

Parsed mushroomdb invocation.

RestoreOutcome

Re-exported where it has always been named: cli::RestoreOutcome. What restore_if_empty did.

SchemaListing

What mushroomdb schema indexes|constraints lists.

ServeUi

How serve should mount a UI. Precedence: --ui dir > embedded > --no-ui.

WalDisposition

What a snapshot does with the WAL it folds in.

Constants

AUTOMATIC_SNAPSHOT

What every snapshot mushroomdb takes on its own does with the WAL.

AUTO_SNAPSHOT_RETENTION

How many WAL archives a snapshot mushroomdb takes on its own keeps. None = all of them. Retention is configured, never defaulted: deleting history nobody asked to delete is not a default worth having.

DEFAULT_RESTORE_INTO

Where restore writes when --into is not given.

DEFAULT_SHUTDOWN_TIMEOUT_SECS

Default for serve --shutdown-timeout-secs: drain up to 25 s, snapshot in what is left of the budget (8 s with the default backup bounds), then flush the backup and release the lease within 22 s.

NO_AUTO_SNAPSHOT_ENV

Set, to anything, in the environment of a mushroomdb mcp that must not snapshot the store it opens.

N_ORGS

Deterministic demo: 10 Orgs, 20 Projects, 30 People.

N_PEOPLE

N_PROJECTS

SAMPLE_QUERY

Sample query printed by mushroomdb demo and executed against the fresh store.

SHUTDOWN_DRAIN_SECS

The drain phase’s share at the default timeout, and its cap at any timeout.

SNAPSHOT_LOCK_WAIT

How long a server-initiated snapshot waits for the store’s cross-process write lock before giving up.

VERSION

Build version, printed by mushroomdb --version.

Functions

build_index_on

run_build_index against an already-open handle.

format_backup

Format a BackupReport for display.

format_demo

Render a DemoOutcome the way mushroomdb demo prints it.

format_restore_s3

Format a backup::RestoreS3Outcome for display.

format_stats

Pretty-print Stats for mushroomdb stats and the demo smoke test.

format_suggest

Pretty-print a list of RuleSuggestions for mushroomdb suggest.

maybe_run_demo_if_empty

Run run_demo when dir is missing or empty; otherwise leave it alone.

parse_args

Parse argv after the binary name. Hand-rolled — no clap.

read_stats

Open dir and return live stats.

resolve_auto_db

Where --auto looks for a database, in order.

resolve_statement

The statement a query or asof was given: inline as it came, or the text of --file or of standard input. A file or pipe ends in a newline the editor or echo put there, which is not part of the statement, so trailing whitespace is dropped.

resolve_tx_limits

The HTTP transaction limits serve runs with: each flag given wins over its environment variable, read through env; a limit given by neither keeps its default.

restore_if_empty

mushroomdb::restore::restore_if_empty, in the CLI’s error type.

run_algo

Run a graph algorithm and return a formatted string.

run_asof

Execute an as-of query at the given commit and print results.

run_backup

Create a consistent, verified backup of db_dir to dest.

run_brief

Body of mushroomdb brief <db-dir>|--auto, the SessionStart hook.

run_build_index

Pump every outstanding vector-index build to completion, one slice per call, printing a line per slice.

run_demo

Build the deterministic demo dataset in an empty dir.

run_export

Export all data from db_dir to dest in format.

run_import

Bulk-load CSV and JSONL files into db_dir; mushroomdb import.

run_migrate

Migrate the snapshot at db_dir to the current format version.

run_query

Run a Cypher read or write and print columns/rows like run_asof.

run_restore_s3

mushroomdb restore --from s3://…: download, verify and install a restore point into into (default DEFAULT_RESTORE_INTO) with backup::restore_from_s3, and say what was restored.

run_schema_apply

Read schema_file, open db_dir, apply the schema, and return the diff as one line per entry: "created rule:x", "updated view:y", etc.

run_schema_apply_memory_defaults

mushroomdb schema apply <db> --memory-defaults

run_schema_apply_memory_identity

mushroomdb schema apply <db> --memory-identity

run_schema_list

mushroomdb schema indexes|constraints: the rows SHOW INDEXES / SHOW CONSTRAINTS give, as a table. The store opens read-only, so this writes nothing and never waits on a writer, a server included.

run_snapshot

Open dir and write snapshot.bin, archiving the WAL by default.

run_suggest

Profile the database at dir and return all rule suggestions.

run_verify

Validate the CRC32 integrity of every section in a V8 snapshot.

run_why

Body of mushroomdb why <db> <a> <b>: every rule edge between two keys with the evidence that derived it, or an honest note that there is none. A key the store does not hold is an error (node key not found: <key>), not an empty answer.

shutdown_plan

Divide total between the phases. backup_bound is the backup’s own shutdown bound (BackupConfig::shutdown_budget), zero without backup.

snapshot_automatically

Take AUTOMATIC_SNAPSHOT under a held write lock, keeping AUTO_SNAPSHOT_RETENTION archives.

snapshot_if_wal_grew

Take the automatic snapshot if the store’s WAL has grown past SNAPSHOT_WAL_BYTES.

snapshot_shared

Take the snapshot serve takes — on a --snapshot-every tick, and once more on a graceful shutdown.

usage

Usage text for no-args / --help / -h.

validate_ui_dir

--ui <dir> must be a directory that contains index.html.

version_string

The one line --version and the version subcommand print.

why_for_stdout

why’s reply as it goes to stdout. A person at a terminal reads the framing line as a warning, so styled dims it; the text stays, because an agent may be reading through a terminal too. Piped output is untouched.

worktree_root

The root of the working tree dir sits in: the nearest ancestor holding a .git entry, or None outside a checkout.