Docs / Usage Build
Output Formats
Text, JSON, NDJSON, Markdown and HTML outputs.
| Command | Formats |
|---|---|
ekos ekl, ekos ask |
text; --json |
ekos doctor |
text checklist; --json (one object) |
ekos graph export |
--format json (one pretty object) or ndjson (header + one record per node/edge) |
ekos ledger timeline |
JSON only |
ekos docs generate |
--format md (default) or html, with Mermaid diagrams |
| MCP tools | JSON results |
Generated documentation
ekos docs generate --layout curated --output doc # README, Architecture, API, SequenceDiagrams
ekos docs generate --layout objects --output doc-objects # one page per significant object
ekos docs generate --layout solution-architect # dependency risk report, onboarding guide, findings memo
Rendering is deterministic and makes no LLM calls — unless you add --prose, which asks for confirmation and a cost estimate first.