Skip to content
/ rfcv Public

Read RFCs in Linux or MacOS terminal with color coding

License

Notifications You must be signed in to change notification settings

amakukha/rfcv

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rfcv

rfcv is a tiny command-line tool written in Python and Bash to display colored RFCs (Requests for Comments) in the Linux or MacOS terminal. It fetches RFCs from the Web and caches them locally.

rfcv makes use of a simple RFC parser to apply color coding to the plain text. It makes the text more readable and easier to understand.

Usage

Type rfcv followed by the RFC number. For example:

rfcv 2549
rfcv 6214

Example screenshots:

RFC6665 viewed in rfcv utility

Prerequisites

  • Python 3
  • Python Requests
    • python3 -m pip install requests
  • less
  • curl (for installing only)

Install

mkdir -p ~/bin
curl -sL https://raw.github.com/amakukha/rfcv/master/rfc_color.py > ~/bin/rfc_color.py
curl -sL https://raw.github.com/amakukha/rfcv/master/rfcv > ~/bin/rfcv
chmod u+x ~/bin/rfcv

This creates the ~/bin directory if it doesn’t exist, and downloads the files into it. If it’s not in your PATH, you have to add it:

echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bashrc

Inspired by

  • Baptiste Fontaine's rfc
  • monsieurh's rfc_reader, with which it can share local copies of RFCs

About

Read RFCs in Linux or MacOS terminal with color coding

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published