Struct Args 

pub struct Args {
    pub format: Format,
    pub output: Option<PathBuf>,
    pub mem_name: Option<String>,
    pub root: Option<String>,
    pub via: Vec<String>,
    pub direction: ChainDirection,
    pub depth: Option<usize>,
    pub self_contained: bool,
    pub base_url: Option<String>,
    pub include: Vec<String>,
}

Export the write mem as markdown (in place), as a portable .mem archive, or as a structured JSON document on stdout.

--format markdown is supported only on folder-backed mems; use --format mem for archive export on git-branch backends. Targeting a mem on an incompatible backend returns MARKDOWN_EXPORT_UNSUPPORTED_BACKEND; workspace-wide markdown export in a mixed-backend workspace completes the folder mounts and lists the declined mounts under skipped_mounts.

--format json is the bulk read: one engine boot emits the complete entity set — per entity the same structured envelope memstead entity --json produces — grouped per mem, backend-uniform, observably read-only. External projections and check scripts consume this instead of per-entity CLI calls (which pay the engine boot per entity) or raw git against the mem-repo.

Fields

format: Format

Output format. markdown regenerates the mem directory in place (folder-backed mems only); mem writes a portable .mem zip suitable for sharing (every backend); json prints every non-stub entity of the selected mem(s) as one structured JSON document on stdout (every backend, read-only); html writes one self-contained page; llms-txt prints the whole mem as one agent-readable Markdown document (every backend, read-only) — the same shape a Memstead deployment serves at /llms-full.txt, rendered by the same engine code so the two cannot drift. A mem archive’s authoring provenance (.memstead/provenance.json) has every private-pattern span redacted to [redacted:<class>] — the leak scan’s classes, one vocabulary — never stripped; the report counts redactions per class. Entity bodies are not rewritten.

output: Option<PathBuf>

Output path for --format mem (default ./<name>-<version>.mem) and --format html (default ./<mem>.html). Optional for --format llms-txt, which prints to stdout when omitted. Ignored for --format markdown; refused for --format json (that document goes to stdout).

mem_name: Option<String>

Which mem to export (by name). For --format markdown, omitting this argument runs a workspace-wide export and reports any declined mounts under skipped_mounts. For --format mem, required when more than one write mem is loaded; defaults to the first writable mem otherwise. For --format json, omitting it exports every writable mem; naming a read-only mount exports that mount (read-mems are excluded from the workspace-wide default — they are someone else’s published content).

root: Option<String>

Export only the chain reachable from this entity (mem--slug) instead of the whole mem — for --format json, html and llms-txt. Requires --via. The root itself is always included; each rendered entity keeps its metadata, sections, relationships and (json) its anchors with live state; stubs in the chain are marked; references to entities outside the chain render as unresolved markers, never as broken links. Without --root the export is the whole mem, byte-identical to before.

via: Vec<String>

Rel-types the chain follows, comma-separated or repeatable (--via SUPPORTS,DERIVES_FROM). Validated against the mem’s schema vocabulary: an unknown name refuses INVALID_REL_TYPE naming the declared rel-types. Only with --root.

direction: ChainDirection

Direction applied at EVERY hop of the chain: out follows edges pointing away from the root (what the root rests on), in follows edges pointing at it (what rests on the root), both the undirected walk. A pure transitive closure in the chosen direction, the same contract memstead search uses.

depth: Option<usize>

Maximum hops from the root (default: unbounded). --depth 1 is the root and its direct neighbours along --via.

self_contained: bool

For --format mem: make the archive self-contained by dropping every ## Relationships row whose target lives in another mem, then re-pack and strictly validate it (the same pass install runs). Without it, a mem that references its sibling mems exports with DANGLING_CROSS_MEM_EDGE_IN_EXPORT warnings and install refuses the archive; with it, every dropped edge is reported as CROSS_MEM_EDGE_DROPPED instead. Section text, body wiki-links included, is never touched: an alias row synthesised from a body link loses nothing the body does not still say.

base_url: Option<String>

Absolute base URL for entity links in --format llms-txt (e.g. https://example.com). With it, references render as absolute links exactly as the served document does; without it they target the document-relative entity/<id>. There is no third form. Ignored by every other format.

include: Vec<String>

Opt extra per-entity content into the --format json document (comma-separated). Keys: anchors — each entity envelope gains an anchors array with its stored provenance anchors, so the file-to-entity map a carving or sync pass starts from is one export instead of one memstead anchors <id> per entity. An unknown key refuses naming the allowed set; refused for every other format.

Trait Implementations

impl Args for Args

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Args

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Args

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

Formats the value using the given formatter.

impl FromArgMatches for Args

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( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Args

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.