Directories
¶
| Path | Synopsis |
|---|---|
|
Package blobs stores PDFs on the filesystem, named by the SHA-256 of their contents.
|
Package blobs stores PDFs on the filesystem, named by the SHA-256 of their contents. |
|
Package config resolves where the library lives and how the tool behaves.
|
Package config resolves where the library lives and how the tool behaves. |
|
Package embed turns text into vectors, over Ollama's local HTTP API.
|
Package embed turns text into vectors, over Ollama's local HTTP API. |
|
Package errs holds the sentinel errors shared across Filiation.
|
Package errs holds the sentinel errors shared across Filiation. |
|
Package export writes the library out as GraphML, JSON and BibTeX. M1.
|
Package export writes the library out as GraphML, JSON and BibTeX. M1. |
|
Package graph grows and traverses the citation graph.
|
Package graph grows and traverses the citation graph. |
|
Package httpx is the shared HTTP layer for every outbound request.
|
Package httpx is the shared HTTP layer for every outbound request. |
|
Package identity classifies and normalises whatever the user typed.
|
Package identity classifies and normalises whatever the user typed. |
|
Package jobs runs long work in the background and survives interruption.
|
Package jobs runs long work in the background and survives interruption. |
|
Package library is the core of Filiation.
|
Package library is the core of Filiation. |
|
Package llm generates answers, through either a local Ollama model or a user-supplied API key.
|
Package llm generates answers, through either a local Ollama model or a user-supplied API key. |
|
Package mcpsrv exposes the library over the Model Context Protocol.
|
Package mcpsrv exposes the library over the Model Context Protocol. |
|
Package model holds the types shared across Filiation: Work, HydratedWork, Edge, Author, FrontierItem, ExpansionResult.
|
Package model holds the types shared across Filiation: Work, HydratedWork, Edge, Author, FrontierItem, ExpansionResult. |
|
Package retrieve answers questions over the library.
|
Package retrieve answers questions over the library. |
|
Package sources holds one subpackage per external API.
|
Package sources holds one subpackage per external API. |
|
openalex
Package openalex is the client for the OpenAlex API — the source of works, metadata, resolved reference lists and open-access locations.
|
Package openalex is the client for the OpenAlex API — the source of works, metadata, resolved reference lists and open-access locations. |
|
unpaywall
Package unpaywall resolves a DOI to a legal open-access PDF location, as the second opinion when the OA locations from OpenAlex come up empty.
|
Package unpaywall resolves a DOI to a legal open-access PDF location, as the second opinion when the OA locations from OpenAlex come up empty. |
|
zotero
Package zotero reads a user's existing Zotero library.
|
Package zotero reads a user's existing Zotero library. |
|
Package store owns every SQL statement in Filiation.
|
Package store owns every SQL statement in Filiation. |
|
Package text turns a stored PDF into searchable text.
|
Package text turns a stored PDF into searchable text. |
|
Package web serves the local single-page app: graph view, search, reader, notes.
|
Package web serves the local single-page app: graph view, search, reader, notes. |
Click to show internal directories.
Click to hide internal directories.