Skip to content
Margo v0.0.5

CLI workflows

#

The margo command is the operational face of the root Go module. Commands write artifacts and reports to stdout, send diagnostics to stderr, and keep destructive output replacement explicit.

The core loop

sh
margo check input.md
margo html input.md --output input.html
margo pdf input.md --output input.pdf
# Experimental deck projection.
margo deck input.md --format html --output input-deck.html
margo site ./docs --output-dir ./dist

Command map

Markdown table
CommandPurpose
checkValidate Markdown compatibility without rendering
htmlRender one standalone HTML page
siteBuild linked HTML pages from a directory
pdfExport a document PDF
deckExperimental HTML or PDF presentation projection
doctorReport PDF engine candidates and reasons
schemaEmit the embedded policy or document schema
versionReport release and compiled capability information

Explicit output boundaries

html defaults to stdout. deck defaults to experimental HTML output and stdout. PDF commands require an explicit output path or - for binary stdout. Existing files are protected unless --force is present, and a site destination must not already exist.

That small amount of friction is intentional: the command tells you which artifact it is about to write and gives automation a stable place to inspect the result.