Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
fil
command
Command fil is the Filiation command-line interface.
|
Command fil is the Filiation command-line interface. |
|
internal
|
|
|
blobs
Package blobs is the filesystem half of a library: its folder, and the papers/ folder inside it where PDFs live (ADR-011, ADR-012).
|
Package blobs is the filesystem half of a library: its folder, and the papers/ folder inside it where PDFs live (ADR-011, ADR-012). |
|
config
Package config resolves where the library lives and how the tool behaves.
|
Package config resolves where the library lives and how the tool behaves. |
|
embed
Package embed turns text into vectors, over Ollama's local HTTP API.
|
Package embed turns text into vectors, over Ollama's local HTTP API. |
|
errs
Package errs holds the sentinel errors shared across Filiation.
|
Package errs holds the sentinel errors shared across Filiation. |
|
export
Package export writes the library out as GraphML, JSON and BibTeX. M1.
|
Package export writes the library out as GraphML, JSON and BibTeX. M1. |
|
graph
Package graph grows and traverses the citation graph.
|
Package graph grows and traverses the citation graph. |
|
httpx
Package httpx is the shared HTTP layer for every outbound request.
|
Package httpx is the shared HTTP layer for every outbound request. |
|
identity
Package identity classifies and normalises whatever the user typed.
|
Package identity classifies and normalises whatever the user typed. |
|
jobs
Package jobs runs long work in the background and survives interruption.
|
Package jobs runs long work in the background and survives interruption. |
|
library
Package library is the core of Filiation.
|
Package library is the core of Filiation. |
|
llm
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. |
|
mcpsrv
Package mcpsrv exposes the library over the Model Context Protocol.
|
Package mcpsrv exposes the library over the Model Context Protocol. |
|
model
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. |
|
retrieve
Package retrieve answers questions over the library.
|
Package retrieve answers questions over the library. |
|
sources
Package sources holds one subpackage per external API.
|
Package sources holds one subpackage per external API. |
|
sources/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. |
|
sources/pdfs
Package pdfs downloads open-access PDFs from the links OpenAlex gives (ADR-013).
|
Package pdfs downloads open-access PDFs from the links OpenAlex gives (ADR-013). |
|
sources/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. |
|
sources/zotero
Package zotero reads a user's existing Zotero library.
|
Package zotero reads a user's existing Zotero library. |
|
store
Package store owns every SQL statement in Filiation.
|
Package store owns every SQL statement in Filiation. |
|
text
Package text turns a stored PDF into searchable text.
|
Package text turns a stored PDF into searchable text. |
|
text/pdftest
Package pdftest writes small, valid PDFs for tests: real files PDFium opens, made in code, so no binary sits in testdata and every test says exactly what its PDF contains.
|
Package pdftest writes small, valid PDFs for tests: real files PDFium opens, made in code, so no binary sits in testdata and every test says exactly what its PDF contains. |
|
web
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. |
|
spikes
|
|
|
1-batch-by-id
command
Command spike1 tests whether OpenAlex works can be fetched in batches by ID.
|
Command spike1 tests whether OpenAlex works can be fetched in batches by ID. |
|
11-reference-matching
command
Command reference-matching is spike 11 (ARCHITECTURE_PHASE3.md §6): how well can a reference list be split out of a PDF's text and matched to real works?
|
Command reference-matching is spike 11 (ARCHITECTURE_PHASE3.md §6): how well can a reference list be split out of a PDF's text and matched to real works? |
|
12-validation-m3
command
Command validation-m3 is the M3 validation run: ARCHITECTURE_PHASE3.md's step 11, the 20 seeds of M1's run (spikes/8-validation) again, now for the papers on disk — PDFs, their text, search, citation context and import.
|
Command validation-m3 is the M3 validation run: ARCHITECTURE_PHASE3.md's step 11, the 20 seeds of M1's run (spikes/8-validation) again, now for the papers on disk — PDFs, their text, search, citation context and import. |
|
2-per-page
command
Command spike2 finds the real per_page maximum on the OpenAlex works endpoint.
|
Command spike2 finds the real per_page maximum on the OpenAlex works endpoint. |
|
3-rate-limit
command
Command spike3 measures the sustained request rate OpenAlex allows in the polite pool.
|
Command spike3 measures the sustained request rate OpenAlex allows in the polite pool. |
|
4-reference-coverage
command
Command spike4 measures OpenAlex reference coverage across research fields.
|
Command spike4 measures OpenAlex reference coverage across research fields. |
|
5-fts5
command
Command spike5 proves that ncruces/go-sqlite3 can run Filiation's real schema, including FTS5.
|
Command spike5 proves that ncruces/go-sqlite3 can run Filiation's real schema, including FTS5. |
|
6-vectors
command
Command spike6 proves vector search works in the same SQLite file as the graph.
|
Command spike6 proves vector search works in the same SQLite file as the graph. |
|
8-validation
command
Command validation is the M1 validation run: ARCHITECTURE_PHASE1.md §10's "20-paper / 5-field" check, run against live OpenAlex before v0.1.
|
Command validation is the M1 validation run: ARCHITECTURE_PHASE1.md §10's "20-paper / 5-field" check, run against live OpenAlex before v0.1. |
|
9-pdf-availability
command
Command pdf-availability is spike 9 (ARCHITECTURE_PHASE3.md §6): of the works in the M1 validation libraries, how many have a PDF we can actually download — per field, per OA status — and how many more does Unpaywall add? How long does one download take?
|
Command pdf-availability is spike 9 (ARCHITECTURE_PHASE3.md §6): of the works in the M1 validation libraries, how many have a PDF we can actually download — per field, per OA status — and how many more does Unpaywall add? How long does one download take? |
Click to show internal directories.
Click to hide internal directories.