magus-examples

command
v0.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 3, 2026 License: GPL-3.0 Imports: 7 Imported by: 0

Documentation

Overview

Command magus-examples keeps the worked examples in the docs honest: it builds the current magus binary, runs curated retrieval-verb invocations against a small fixture workspace, captures their ACTUAL stdout, and injects each into docs/knowledge.md between HTML markers (<!-- example:<slug> --> ... <!-- /example -->). So the example output is never hand-typed - it is exactly what `magus explain`/`path` print, from a controlled fixture with stable IDs (same approach the txtar tests use, just captured instead of asserted). It mirrors magus-spelldocs (derive committed Markdown from a source of truth) and rides the same generate + vcs.isDirty drift gate: change the renderer, forget to regenerate, and CI fails.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL