Skip to main content

Module quickstart

Module quickstart 

Source
Expand description

memstead quickstart — the batteries-included cold start.

One run in a fresh (or trivially-dirty) directory leaves: a bootable filesystem-mem workspace pinned to the default schema, one seed entity so the graph is non-empty, and the MCP wiring for the selected agent targets. Output names each artifact plus the single next action.

Contract split against memstead init: init is the deliberate, script-safe verb — exact pins, strict emptiness, no side effects beyond .memstead/. quickstart is the newcomer verb — it derives the mem name from the directory, tolerates dotfiles and README-grade files, and writes agent config. It composes the same engine primitives (init_filesystem_mem, Engine::create_entity) rather than forking a second init path; the write-validation strictness downstream of the doorway is untouched.

Interactivity ceiling: two prompts, both TTY-only, both with a flag alternative — the agent-target selection (--agent bypasses) and the mem name when derivation from the directory fails (--name bypasses). Non-interactive runs never block: no --agent defaults to Claude Code (and says so), an underivable name refuses with the exact command to run instead.

Structs§

Args
memstead quickstart arguments.

Enums§

AgentTarget
The supported agent targets and the wiring each one gets. The three file-writing targets take project-scoped MCP config; Codex reads MCP servers only from its global ~/.codex/config.toml, so its wiring is the exact codex mcp add command printed as the next action — quickstart never writes outside the target directory.

Functions§

run