https://github.com/apainintheneck/rfc-reader

Read RFCs at the command line
https://github.com/apainintheneck/rfc-reader

cli gem rfc ruby

Last synced: 4 months ago
JSON representation

Read RFCs at the command line

• Host: GitHub
• URL: https://github.com/apainintheneck/rfc-reader
• Owner: apainintheneck
• License: mit
• Created: 2024-09-08T21:09:30.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-11-23T03:04:50.000Z (7 months ago)
• Last Synced: 2025-12-15T04:10:59.255Z (7 months ago)
• Topics: cli, gem, rfc, ruby
• Language: Ruby
• Homepage: https://rubygems.org/gems/rfc-reader
• Size: 1.18 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# RfcReader

[![Gem Version](https://badge.fury.io/rb/rfc-reader.svg)](https://badge.fury.io/rb/rfc-reader)

This is a simple gem that makes it easy to find and read RFCs listed on `rfc-editor.com`.

Note: This gem is not directly affiliated with `rfc-editor.com`. It's just a hobby project.

## Installation

```console

gem install rfc-reader

```

## Usage

```

>>> rfc-reader

This command downloads the plaintext version of RFCs from

rfc-editor.org so that they can be read at the command line.

The last 100 downloaded RFCs are saved locally so that they can be

read later on without the need for an internet connection.

Commands:

  rfc-reader help [COMMAND]  # Describe available commands or one specific command

  rfc-reader library         # List already downloaded RFCs for reading

  rfc-reader recent          # List recent RFC releases for reading

  rfc-reader search [TERM]   # Search for RFCs by TERM for reading

  rfc-reader version         # Print the program version

```

## Demo

![GIF showing usage of the command: rfc-reader search json](./assets/rfc-reader-1.1.1.cast.gif)

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run tests. Run the linter with `rake standard`. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/apainintheneck/rfc-reader.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).