Output Formats
Text, JSON, NDJSON, Markdown and HTML outputs.
| Command | Formats |
|---|---|
ekos ekl, ekos ask |
text; --json |
ekos doctor, ekos status, ekos coverage, ekos freshness |
text; --json (one object) |
ekos review list|show, ekos workflow status, ekos conflicts list, ekos database list|test, ekos source list, ekos llm usage |
text; --json |
ekos check refs |
--format table (default), json or sarif (SARIF 2.1.0, for code-scanning tools) |
ekos graph export |
--format json (one pretty object) or ndjson (header + one record per node/edge) |
ekos ledger timeline |
JSON only |
ekos commands, ekos extensions, ekos config schema |
JSON (what the web console builds its forms from) |
ekos docs generate |
--format md (default) or html, with Mermaid diagrams |
| Run logs | JSON lines, one per step, ending with the run's model-call count |
| MCP tools | JSON results |
Generated documentation
ekos docs generate --output doc-objects # default layout "objects": one page per significant object
ekos docs generate --layout curated --output doc # README, Architecture, API, SequenceDiagrams
ekos docs generate --layout solution-architect # dependency risk report, onboarding guide, findings memo
ekos docs generate --layout estate # a database estate as wiki pages
Without --output, pages go to <workspace>/docs-generated (a home project's out/
directory). The curated and solution-architect layouts are Markdown only.
--layout estate renders a database estate — areas, tables, glossary, lifecycles, logic,
history, findings, reference integrity — in the page format the lakehouse-docs publishers read
(GitHub wiki, Confluence, Azure DevOps). Two gates are built in: no data value reaches a page (a
column profile gives counts only), and text is used only from sources with a known licence
([docs-estate] licences overrides the licence file found at a source's root). Regenerating keeps
manual sections and deletes only pages it generated.
Rendering is deterministic and makes no LLM calls — unless you add --prose, which asks for confirmation and a cost estimate first.