Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
corr
command
Command corr reads and manages a Correspondent server from the terminal.
|
Command corr reads and manages a Correspondent server from the terminal. |
|
correspondent
command
Command correspondent runs the feed reader.
|
Command correspondent runs the feed reader. |
|
internal
|
|
|
api
Package api implements the modern JSON API consumed by the web reader.
|
Package api implements the modern JSON API consumed by the web reader. |
|
apns
Package apns sends notifications to the Apple apps through Apple's Push Notification service, with token-based authentication: an APNs key (.p8, from the developer account), its key ID and the team ID sign a short JWT that is reused for 40 minutes.
|
Package apns sends notifications to the Apple apps through Apple's Push Notification service, with token-based authentication: an APNs key (.p8, from the developer account), its key ID and the team ID sign a short JWT that is reused for 40 minutes. |
|
client
Package client talks to a Correspondent server's /api/v1 with a personal API token.
|
Package client talks to a Correspondent server's /api/v1 with a personal API token. |
|
content
Package content turns untrusted feed HTML into the sanitized HTML that is stored and rendered.
|
Package content turns untrusted feed HTML into the sanitized HTML that is stored and rendered. |
|
extract
Package extract fetches an article's web page and pulls out the article itself (Readability, as in Firefox's Reader View), for feeds that publish only titles or summaries.
|
Package extract fetches an article's web page and pulls out the article itself (Readability, as in Firefox's Reader View), for feeds that publish only titles or summaries. |
|
feed
Package feed normalizes RSS, Atom and JSON Feed documents into entries ready for storage, and discovers feed links in HTML pages.
|
Package feed normalizes RSS, Atom and JSON Feed documents into entries ready for storage, and discovers feed links in HTML pages. |
|
fetch
Package fetch is the only way Correspondent reaches the network.
|
Package fetch is the only way Correspondent reaches the network. |
|
greader
Package greader is the Google Reader–compatible facade used by Reeder and other clients, mounted at the FreshRSS path /api/greader.php.
|
Package greader is the Google Reader–compatible facade used by Reeder and other clients, mounted at the FreshRSS path /api/greader.php. |
|
imgproxy
Package imgproxy serves article images, thumbnails and feed icons through Correspondent, so third-party sites never see the reader's address and thumbnails arrive at the size they're shown.
|
Package imgproxy serves article images, thumbnails and feed icons through Correspondent, so third-party sites never see the reader's address and thumbnails arrive at the size they're shown. |
|
ingest
Package ingest polls due feeds, stores new entries, and subscribes to new feeds (with discovery from HTML pages).
|
Package ingest polls due feeds, stores new entries, and subscribes to new feeds (with discovery from HTML pages). |
|
integrations
Package integrations sends articles to services a reader connects: a webhook of their own, read-later services (Readwise Reader, Instapaper, Raindrop) and self-hosted ones (Wallabag, Linkding, Karakeep).
|
Package integrations sends articles to services a reader connects: a webhook of their own, read-later services (Readwise Reader, Instapaper, Raindrop) and self-hosted ones (Wallabag, Linkding, Karakeep). |
|
mcpserver
Package mcpserver offers a reader's Correspondent to AI tools over the Model Context Protocol.
|
Package mcpserver offers a reader's Correspondent to AI tools over the Model Context Protocol. |
|
migrate
Package migrate imports a FreshRSS account.
|
Package migrate imports a FreshRSS account. |
|
opml
Package opml reads and writes subscription lists.
|
Package opml reads and writes subscription lists. |
|
pagefeed
Package pagefeed turns a web page that lists articles (a blog index, a research page) into feed items, for sites that publish no feed.
|
Package pagefeed turns a web page that lists articles (a blog index, a research page) into feed items, for sites that publish no feed. |
|
push
Package push sends Web Push notifications for new articles in feeds the user opted in to, to the devices that turned notifications on.
|
Package push sends Web Push notifications for new articles in feeds the user opted in to, to the devices that turned notifications on. |
|
ratelimit
Package ratelimit throttles failed sign-ins per client, and resolves the real client address when running behind a trusted reverse proxy.
|
Package ratelimit throttles failed sign-ins per client, and resolves the real client address when running behind a trusted reverse proxy. |
|
secretbox
Package secretbox encrypts small secrets that readers give the app (an AI API key) before they are stored in the database.
|
Package secretbox encrypts small secrets that readers give the app (an AI API key) before they are stored in the database. |
|
server
Package server assembles the HTTP surface: the reader UI, the modern API, the Google Reader facade, and health endpoints.
|
Package server assembles the HTTP surface: the reader UI, the modern API, the Google Reader facade, and health endpoints. |
|
speech
Package speech reads articles aloud with a reader's own text-to-speech provider: OpenAI or a compatible service, ElevenLabs, or Deepgram.
|
Package speech reads articles aloud with a reader's own text-to-speech provider: OpenAI or a compatible service, ElevenLabs, or Deepgram. |
|
store
Package store owns the SQLite database: schema migrations, entry-ID allocation, and every query the application runs.
|
Package store owns the SQLite database: schema migrations, entry-ID allocation, and every query the application runs. |
|
textify
Package textify turns sanitized article HTML into Markdown, for reading in a terminal and for AI agents: headings, paragraphs, links, lists, quotations, code and images keep their meaning; everything else is text.
|
Package textify turns sanitized article HTML into Markdown, for reading in a terminal and for AI agents: headings, paragraphs, links, lists, quotations, code and images keep their meaning; everything else is text. |
|
typesafe
Package typesafe asks TypeSafe's Jev model yes-or-no questions (its Noul judgments) about a piece of state.
|
Package typesafe asks TypeSafe's Jev model yes-or-no questions (its Noul judgments) about a piece of state. |
|
version
Package version reports what is running.
|
Package version reports what is running. |
|
Package web embeds the built reader UI (produced by `make ui` into dist/).
|
Package web embeds the built reader UI (produced by `make ui` into dist/). |
Click to show internal directories.
Click to hide internal directories.








