{"id":13581609,"url":"https://github.com/mrusme/reader","last_synced_at":"2025-04-06T18:14:36.597Z","repository":{"id":52481108,"uuid":"461348090","full_name":"mrusme/reader","owner":"mrusme","description":"reader is for your command line what the “readability” view is for modern browsers: A lightweight tool offering better readability of web pages on the CLI.","archived":false,"fork":false,"pushed_at":"2024-08-01T20:11:52.000Z","size":22318,"stargazers_count":278,"open_issues_count":6,"forks_count":11,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-29T22:32:32.364Z","etag":null,"topics":["ascii","ascii-art","cli","command-line","command-line-tool","html","html-to-markdown","markdown","readability","reader","terminal","terminal-based","tui","web"],"latest_commit_sha":null,"homepage":"https://xn--gckvb8fzb.com/reader-web-page-readability-on-the-cli/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mrusme.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"custom":["https://github.com/mrusme#support"]}},"created_at":"2022-02-20T00:34:07.000Z","updated_at":"2024-10-26T04:11:39.000Z","dependencies_parsed_at":"2024-01-08T21:15:00.787Z","dependency_job_id":"75ac9081-3c1a-4c79-9029-6ef966df7d97","html_url":"https://github.com/mrusme/reader","commit_stats":{"total_commits":61,"total_committers":4,"mean_commits":15.25,"dds":"0.14754098360655743","last_synced_commit":"cce32253300274b1389db81415a590578b35ff20"},"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Freader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Freader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Freader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Freader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrusme","download_url":"https://codeload.github.com/mrusme/reader/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247526763,"owners_count":20953143,"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":["ascii","ascii-art","cli","command-line","command-line-tool","html","html-to-markdown","markdown","readability","reader","terminal","terminal-based","tui","web"],"created_at":"2024-08-01T15:02:07.707Z","updated_at":"2025-04-06T18:14:36.579Z","avatar_url":"https://github.com/mrusme.png","language":"Go","readme":"reader\n------\n\n[![Static \nBadge](https://img.shields.io/badge/Join_on_Matrix-green?style=for-the-badge\u0026logo=element\u0026logoColor=%23ffffff\u0026label=Chat\u0026labelColor=%23333\u0026color=%230DBD8B\u0026link=https%3A%2F%2Fmatrix.to%2F%23%2F%2521PHlbgZTdrhjkCJrfVY%253Amatrix.org)](https://matrix.to/#/%21PHlbgZTdrhjkCJrfVY%3Amatrix.org)\n\n*reader* is for your command line what the “readability” view is for modern\nbrowsers: A lightweight tool offering better readability of web pages on the\nCLI.\n\n![reader](demo.gif)\n\n`reader` parses a web page for its actual content and displays it in nicely\nhighlighted text on the command line. In addition, `reader` renders embedded\nimages from that page as colored block-renders on the terminal as well.\n\n\n## Installation \n\n```\ngo install github.com/mrusme/reader@latest\n```\n\nIf the above fails, then the following should work:\n\n```\ngit clone https://github.com/mrusme/reader.git\ncd reader\ngo install \n```\n\n\n## Usage\n\n```sh\nreader https://xn--gckvb8fzb.com/superhighway84/\n```\n\nDon't render images:\n\n```sh\nreader --image-mode none https://xn--gckvb8fzb.com/superhighway84/\n```\n\nOutput raw markdown, don't pretty print:\n\n```sh\nreader -o https://xn--gckvb8fzb.com/superhighway84/\n```\n\nRead from file:\n\n```sh\nreader ${HOME}/downloads/example.com.html\n```\n\nRead from stdin:\n\n```sh\ncurl -o - https://superhighway84.com | reader -\n```\n\nRender images using the SIXEL graphics encoder:\n\n```sh\nreader --image-mode sixel https://xn--gckvb8fzb.com/travel-aruba/\n```\n\n![sixel](sixel.png)\n\nMore options:\n\n```sh\nreader -h\n```\n\n\n## Examples\n\n\n### Using `reader` from within `w3m`\n\nWhile on a web page in w3m, press `!` and enter the following:\n\n```\nreader $W3M_URL\n```\n\nThis will open the current url with `reader`. `w3m` will wait for you to press\nany key in order to resume browsing.\n\nIf you want to navigate through the page:\n\n```\nreader $W3M_URL | less -R\n```\n\n\n### Using `reader` from within `vim`/`neovim`\n\nAdd the following function/mapping to your `init.vim`:\n\n```\nfunction s:vertopen_url()\n  normal! \"uyiW\n  let mycommand = \"reader \" . @u\n  execute \"vertical terminal \" . mycommand\nendfunction\nnoremap \u003cPlug\u003evertopen_url : call \u003cSID\u003evertopen_url()\u003cCR\u003e\nnmap gx \u003cPlug\u003evertopen_url\n```\n\nOpen a document and place the cursor on a link, then press `g` followed by `x`.\nVim will open a new terminal and show you the output of `reader`.\n\n\n\n","funding_links":["https://github.com/mrusme#support"],"categories":["Go","\u003ca name=\"viewers\"\u003e\u003c/a\u003eViewers"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrusme%2Freader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrusme%2Freader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrusme%2Freader/lists"}