Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pluckr
command
Command pluckr is the CLI entry point.
|
Command pluckr is the CLI entry point. |
|
internal
|
|
|
chunk
Package chunk splits a rendered Document into the indexable units used by the retriever.
|
Package chunk splits a rendered Document into the indexable units used by the retriever. |
|
cli
Package cli implements the pluckr command-line interface using cobra.
|
Package cli implements the pluckr command-line interface using cobra. |
|
fetch
Package fetch defines a minimal Fetcher abstraction.
|
Package fetch defines a minimal Fetcher abstraction. |
|
mcp
Package mcp implements the pluckr MCP server.
|
Package mcp implements the pluckr MCP server. |
|
pipeline
Package pipeline wires Source -> Renderer -> Chunker -> Store + Retriever into a single end-to-end ingest.
|
Package pipeline wires Source -> Renderer -> Chunker -> Store + Retriever into a single end-to-end ingest. |
|
registry
Package registry owns the user-managed list of subscribed sources.
|
Package registry owns the user-managed list of subscribed sources. |
|
render
Package render turns the bytes a fetcher returned into a clean Document.
|
Package render turns the bytes a fetcher returned into a clean Document. |
|
retriever
Package retriever defines the search interface and the value types callers use to drive it.
|
Package retriever defines the search interface and the value types callers use to drive it. |
|
retriever/fts5
Package fts5 implements retriever.Retriever on top of SQLite FTS5 via the pure-Go modernc.org/sqlite driver.
|
Package fts5 implements retriever.Retriever on top of SQLite FTS5 via the pure-Go modernc.org/sqlite driver. |
|
source
Package source defines the abstraction over an ingestible thing - a public docs site, an llms.txt endpoint, a GitHub repo, or a local folder - and the helper utilities that every implementation needs.
|
Package source defines the abstraction over an ingestible thing - a public docs site, an llms.txt endpoint, a GitHub repo, or a local folder - and the helper utilities that every implementation needs. |
|
source/github
Package github implements the github Source kind: ingest the markdown files from a public GitHub repository via the public API (tree listing) and raw.githubusercontent.com (file contents).
|
Package github implements the github Source kind: ingest the markdown files from a public GitHub repository via the public API (tree listing) and raw.githubusercontent.com (file contents). |
|
source/llmstxt
Package llmstxt implements the llms.txt Source kind, a fast lane for sites that publish the emerging /llms.txt or /llms-full.txt convention (see https://llmstxt.org).
|
Package llmstxt implements the llms.txt Source kind, a fast lane for sites that publish the emerging /llms.txt or /llms-full.txt convention (see https://llmstxt.org). |
|
source/local
Package local implements the local Source kind: read markdown / text files from a directory tree on disk.
|
Package local implements the local Source kind: read markdown / text files from a directory tree on disk. |
|
source/website
Package website implements the website Source kind: discover URLs via sitemap, then nav extraction, then BFS link crawl, then fetch each URL through the supplied Fetcher.
|
Package website implements the website Source kind: discover URLs via sitemap, then nav extraction, then BFS link crawl, then fetch each URL through the supplied Fetcher. |
|
store
Package store owns the on-disk layout of a pluckr cache:
|
Package store owns the on-disk layout of a pluckr cache: |
|
types
Package types defines the small set of value types that flow through the fetch -> render -> chunk -> index -> serve pipeline.
|
Package types defines the small set of value types that flow through the fetch -> render -> chunk -> index -> serve pipeline. |
Click to show internal directories.
Click to hide internal directories.