{"id":14235922,"url":"https://github.com/bfontaine/rfc","last_synced_at":"2025-04-12T19:48:18.477Z","repository":{"id":7615746,"uuid":"8974412","full_name":"bfontaine/rfc","owner":"bfontaine","description":":page_facing_up: Read RFCs from the command-line","archived":false,"fork":false,"pushed_at":"2024-10-28T11:26:23.000Z","size":98,"stargazers_count":235,"open_issues_count":0,"forks_count":22,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-12T19:48:13.679Z","etag":null,"topics":["bash","cli","rfc","shell","tool"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"bodokaiser/node-walve","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bfontaine.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-03-23T17:49:12.000Z","updated_at":"2025-04-08T15:30:30.000Z","dependencies_parsed_at":"2024-03-28T14:29:47.118Z","dependency_job_id":"6cf1248e-5de1-4e98-b233-a1dc87878cb2","html_url":"https://github.com/bfontaine/rfc","commit_stats":{"total_commits":123,"total_committers":9,"mean_commits":"13.666666666666666","dds":"0.11382113821138207","last_synced_commit":"f8431eeedaaf37a2b15e4ce981f3e8a1cae3f4f2"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfontaine%2Frfc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfontaine%2Frfc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfontaine%2Frfc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bfontaine%2Frfc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bfontaine","download_url":"https://codeload.github.com/bfontaine/rfc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625498,"owners_count":21135513,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","cli","rfc","shell","tool"],"created_at":"2024-08-20T21:02:31.120Z","updated_at":"2025-04-12T19:48:18.457Z","avatar_url":"https://github.com/bfontaine.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# rfc\n\n`rfc` is a simple tool written in Bash to read [RFCs][ietf-rfc] from the\ncommand-line. It fetches RFCs and drafts from the Web and caches them\nlocally.\n\n[ietf-rfc]: https://www.ietf.org/standards/rfcs/\n\n## Usage\n\nJust type `rfc` followed by the RFC number or the draft name:\n\n```\n$ rfc \u003cRFC number\u003e\n```\n\ne.g.:\n\n```sh\nrfc 42 # Read the RFC 42\nrfc 1234 # Read the RFC 1234\nrfc draft-ietf-core-coap-18 # Read IETF draft core-coap version 18\n```\n\nUse `rfc help` to see all available subcommands.\n\n### Options\n\n- `--version`: same as the `version` subcommand\n- `--help`: same as the `help` subcommand\n\n### Exit codes\n\n- `0`: normal execution\n- `1`: the requested RFC or archive cannot be found\n- `2`: unrecognized option/subcommand\n- `3`: unable to connect to the network\n- `4`: can't find `curl` nor `wget`\n\n## Install\n\n### Basic install\n\n```sh\nmkdir -p ~/bin\ncurl -sL https://raw.githubusercontent.com/bfontaine/rfc/v1.0.1/rfc \u003e ~/bin/rfc\nchmod u+x ~/bin/rfc\n```\n\nThis creates the `~/bin` directory if it doesn’t exist, and download `rfc` in it.\nIf it’s not in your `PATH`, you have to add it:\n\n```sh\necho 'export PATH=\"$HOME/bin:$PATH\"' \u003e\u003e ~/.bashrc\n```\n\nYou may also want to install the `manpage`, located in [`man/rfc.1`][manpage].\n\n[manpage]: https://raw.githubusercontent.com/bfontaine/rfc/v1.0.1/man/rfc.1\n\n### Using Homebrew\n\nIf you use [Homebrew](http://brew.sh) or [Linuxbrew](http://linuxbrew.sh/) you\ncan install `rfc` with one command:\n\n```sh\nbrew install bfontaine/utils/rfc\n```\n\n### Archlinux\n\nFor archlinux users, you can use the AUR package [rfc-read](https://aur.archlinux.org/packages/rfc-read/).\n\nThe command for use it is `rfc`.\n\n### openSUSE\nThe openSUSE package is called [rfc-read](https://build.opensuse.org/package/show/utilities/rfc-read)\nand can be installed via `zypper in rfc-read`.\n\n### Requirements\n\n- `curl` or `wget`. It uses `$CURL` if it’s set, and fallback on `curl` and then `wget`.\n- `less` or another pager. It uses `$PAGER` if it’s set.\n\n## Customization\n\nYou can choose which directory `rfc` uses by setting the `RFC_DIR` environment\nvariable. The directory is automatically created if it doesn’t exist.\n\nThe default directory is `$XDG_CACHE_HOME/RFCs` if `XDG_CACHE_HOME` is set, otherwise `~/.cache/RFCs`.\n\n## Troubleshooting\n\n`rfc` version 0.2.5 and above has a special `--debug` flag that, if passed as\nthe first argument, enables tracing of all the Bash commands in the script.\n\n## Credits\n\nBaptiste Fontaine and [contributors](https://github.com/bfontaine/rfc/graphs/contributors).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbfontaine%2Frfc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbfontaine%2Frfc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbfontaine%2Frfc/lists"}