EverOS/docs/everos-demo.md

1.4 KiB

EverOS Demo

everos demo is a local educational TUI. It helps new users feel the memory lifecycle before they configure API keys, start the server, or write real memory through the API.

Run It

everos demo

The command asks for one memory and one recall question, then opens a full-screen terminal UI. The visual flow is deterministic and local to the CLI: conversation -> memory sphere -> recall -> source proof -> confetti.

For non-interactive shells or a copyable preview, use:

everos demo --plain

For the looping showroom view used by README media, use:

everos demo --cinematic

What It Does Not Do

The demo does not connect to the EverOS server, call LLM providers, or write production memory files. It is intentionally hardcoded so users can try the experience before configuring the full runtime.

Source Layout

The CLI command adapter stays under src/everos/entrypoints/cli/commands/demo.py because the public command is still everos demo.

The TUI implementation lives under src/everos/entrypoints/tui/demo/:

  • app.py renders the Textual app.
  • data.py builds the deterministic demo story.
  • widgets/sphere.py builds the memory sphere frames.
  • readme_media.py renders README media.

To regenerate README media locally:

uv run python -m everos.entrypoints.tui.demo.readme_media --out-dir /tmp/everos-demo-media