A tool to read IETF RFCs (Request for Comments) with a TUI, allowing you to fetch, cache, and browse them.
- View documents directly in the terminal
- Automatic caching of the documents for offline reading
- Text search functionality within document
- Table of contents navigation
Note
Table of contents section might not always be accurate, as there's no standard way to extract it from RFCs. It works best with RFCs that have a well-defined TOC.
- Keyboard controls
rfc_reader [OPTIONS] [RFC_NUMBER]# Read a specific RFC
rfc_reader 2616
# Read a specific RFC in offline mode (only works if previously cached)
rfc_reader --offline 2616
# Clear the RFC cache
rfc_reader --clear-cache--offline,-o: Run in offline mode (only load cached RFCs)--clear-cache: Clear the RFC cache
Refer to rfc_reader --help for more options.
Refer to the wiki for keybindings.
Rust 1.88.0 or newer.
RFCs are cached locally to improve performance and enable offline reading.
Linux:
/home/{YOUR_USERNAME}/.config/rfc_readerMacOS:
/Users/{YOUR_USERNAME}/Library/Application Support/rfc_readerWindows:
C:\Users\{YOUR_USERNAME}\AppData\Roaming\rfc_reader\configI don't know very well about contribution/PR stuff. Contact me or create a issue if for any issues or suggestions.
This project is licensed under the MIT License. See the LICENSE file for details.