@dgellow/rfc
v0.0.6
Published
Read, search, and navigate IETF RFCs from your terminal
Downloads
32
Readme
rfc
Read, search, and navigate IETF RFCs from your terminal.
Install
From JSR:
deno install -g -A --name rfc jsr:@dgellow/rfc/cliFrom source:
git clone https://github.com/dgellow/rfc && cd rfc
deno task installUsage
rfc Interactive TUI
rfc <number> Read in $PAGER
rfc search <query> Search RFCs
rfc info <number> Show metadata
rfc sync Download all RFCs via rsync
rfc sync --index Refresh the index only
rfc list List cached RFCs
rfc path <number> Print local file pathSearch
Free text and structured queries, powered by SQLite FTS5:
rfc search HTTP/2
rfc search author:fielding
rfc search status:standard wg:httpbis
rfc search year:2022 TLSCLI output is colored by default. Respects $NO_COLOR. Use --no-color to
disable.
TUI
rfc with no arguments opens an interactive browser.
/to search,j/kto navigate,Enterto openTabto filter by status,sto cycle sort orderifor metadata panel,?for full keybindings- In-document search, cross-reference navigation, history
Supports vim (default) and emacs keybindings. Set RFC_KEYMAP=emacs.
Library
import { ensureIndex, getRfc, search } from "jsr:@dgellow/rfc";
const db = await ensureIndex();
const { results } = search(db, "HTTP semantics", { orderBy: "relevance" });Data
RFCs are cached locally in ~/.cache/rfc/ (Linux) or ~/Library/Caches/rfc/
(macOS). The index is fetched from rfc-editor.org
on first run and refreshed daily. Individual RFCs are fetched on demand and
cached permanently.
Dependencies
- Deno
- @dgellow/weew — TUI
- @libs/xml — XML parsing
- @db/sqlite — SQLite + FTS5
