Serve Command

zetl serve starts a local web server for browsing the vault in a browser.

Usage

zetl -d ./my-vault serve              # http://localhost:3000
zetl -d ./my-vault serve --port 8080

Flags

FlagDefaultDescription
--port N3000Port to listen on

Features

The web UI provides:

  • Rendered pages — Markdown rendered to HTML with syntax highlighting
  • Sidebar — page list with search/filter
  • Backlink list — pages linking to the current page
  • Transclusion panel — forward-link excerpt cards with SVG bridge connectors, mirroring the View Command design
  • Inline editing — edit a page in the browser and save; zetl re-indexes on save

Relationship to other viewers

ViewerInterfaceRead-only?
zetl tuiTerminal (multi-view dashboard)Yes
zetl viewTerminal (two-pane reader)Yes
zetl serveBrowser (full web UI)No (inline editing)
zetl buildStatic HTML (deployable)Yes

Design

The server uses the same Link Graph and architecture/Cache as all other commands. The transclusion panel implements the same Xanadu-inspired design as View Command, but with SVG bridge connectors instead of terminal graphics. See Xanadu Lineage for the design philosophy.

See also: CLI Reference, Build Command, View Command, TUI

Backlinks