Directories
¶
| Path | Synopsis |
|---|---|
|
Package config loads the optional per-repo `.matlatl.yml` configuration file that lives at the scan root (a sibling of `.matlatlignore`).
|
Package config loads the optional per-repo `.matlatl.yml` configuration file that lives at the scan root (a sibling of `.matlatlignore`). |
|
Package emit renders analysis results into machine- and CI-consumable artifacts (findings.json, JUnit XML) and writes them safely under an output directory.
|
Package emit renders analysis results into machine- and CI-consumable artifacts (findings.json, JUnit XML) and writes them safely under an output directory. |
|
diagram
Package diagram renders the reference graph as hand-rolled Mermaid and DOT / Graphviz text.
|
Package diagram renders the reference graph as hand-rolled Mermaid and DOT / Graphviz text. |
|
graphjson
Package graphjson renders graph.json — the PRIMARY machine-/LLM-queryable artifact: a compact, schemaVersion-stamped, fully parseable manifest of the analyzed corpus (nodes, edges, sections, components, HITS, and every gap/ orphan/broken-link signal).
|
Package graphjson renders graph.json — the PRIMARY machine-/LLM-queryable artifact: a compact, schemaVersion-stamped, fully parseable manifest of the analyzed corpus (nodes, edges, sections, components, HITS, and every gap/ orphan/broken-link signal). |
|
index
Package index renders index.md: a navigable flat index of every document by canonical DocumentID, with a one-line description (front matter → first H1 fallback), category/section, and mod-date.
|
Package index renders index.md: a navigable flat index of every document by canonical DocumentID, with a one-line description (front matter → first H1 fallback), category/section, and mod-date. |
|
llmstxt
Package llmstxt renders the llms.txt family — the LLM-facing navigation and context artifacts:
|
Package llmstxt renders the llms.txt family — the LLM-facing navigation and context artifacts: |
|
report
Package report renders the human-audience analysis reports: a colorized, TTY-aware terminal summary and a committable GitHub-flavored Markdown report.
|
Package report renders the human-audience analysis reports: a colorized, TTY-aware terminal summary and a committable GitHub-flavored Markdown report. |
|
trails
Package trails renders trails.json — the suggested reading-order artifact (ADR 0016).
|
Package trails renders trails.json — the suggested reading-order artifact (ADR 0016). |
|
Package fsscanner implements application.FileScanner: it walks a repository root, discovers markdown files, applies ignore rules, and enforces the security boundary of ADR 0003 (no symlink following, root containment, resource caps).
|
Package fsscanner implements application.FileScanner: it walks a repository root, discovers markdown files, applies ignore rules, and enforces the security boundary of ADR 0003 (no symlink following, root containment, resource caps). |
|
Package linkcheck implements application.ExternalLinkChecker: an opt-in (--check-external) HTTP liveness checker for external http(s) links, with a mandatory SSRF guard (ADR 0003).
|
Package linkcheck implements application.ExternalLinkChecker: an opt-in (--check-external) HTTP liveness checker for external http(s) links, with a mandatory SSRF guard (ADR 0003). |
|
Package mcpserver exposes a matlatl analysis as a read-only MCP server over streamable HTTP, for an agent to query a markdown corpus' link graph.
|
Package mcpserver exposes a matlatl analysis as a read-only MCP server over streamable HTTP, for an agent to query a markdown corpus' link graph. |
|
Package mdparser implements application.DocumentParser.
|
Package mdparser implements application.DocumentParser. |
Click to show internal directories.
Click to hide internal directories.