{"id":18309084,"url":"https://github.com/typicalam/goread","last_synced_at":"2025-05-15T12:02:57.505Z","repository":{"id":65231173,"uuid":"583640426","full_name":"TypicalAM/goread","owner":"TypicalAM","description":"Beautiful program to read your RSS/Atom feeds right in the terminal!","archived":false,"fork":false,"pushed_at":"2025-02-17T18:16:20.000Z","size":2244,"stargazers_count":458,"open_issues_count":3,"forks_count":19,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-15T12:02:54.057Z","etag":null,"topics":["atom","bubbletea","golang","rss","tui"],"latest_commit_sha":null,"homepage":"","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/TypicalAM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2022-12-30T12:16:29.000Z","updated_at":"2025-05-12T03:57:37.000Z","dependencies_parsed_at":"2023-12-03T21:26:06.997Z","dependency_job_id":"30737b94-3188-4c6b-bf64-f4eea1d4478d","html_url":"https://github.com/TypicalAM/goread","commit_stats":{"total_commits":388,"total_committers":8,"mean_commits":48.5,"dds":0.0489690721649485,"last_synced_commit":"86c63fb3c5829a8266d080193358f215c34a8478"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypicalAM%2Fgoread","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypicalAM%2Fgoread/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypicalAM%2Fgoread/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TypicalAM%2Fgoread/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TypicalAM","download_url":"https://codeload.github.com/TypicalAM/goread/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254337612,"owners_count":22054253,"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":["atom","bubbletea","golang","rss","tui"],"created_at":"2024-11-05T16:10:11.213Z","updated_at":"2025-05-15T12:02:57.453Z","avatar_url":"https://github.com/TypicalAM.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg width=\"500\" src=\"assets/cover.png\" /\u003e\n\u003c/p\u003e\n\n👋 Hello! goread is an RSS/Atom feed reader for the terminal. It allows you to categorize and follow feeds and read articles right in the commandline! It's accompanied by a beautiful TUI made with [bubble tea](https://github.com/charmbracelet/bubbletea). Features include:\n\n- Categorizing feeds\n- Downloading articles for later use\n- Offline mode\n- Customizable colorschemes\n- OPML file support\n- A nice and simple TUI\n\n## ❤️ Getting started\n\n### Installing with `go install`\n\nYou can install goread using the `go` internal package manager\n\n```\n$ go install github.com/TypicalAM/goread@latest\n```\n\n### Installing with `homebrew`\n\nIf you use [Homebrew](https://brew.sh/), you can install [goread](https://formulae.brew.sh/formula/goread) via:\n\n```\n$ brew install goread\n```\n\n### Installing from AUR\n\nIf you use the [AUR](https://aur.archlinux.org/), you can install [goread](https://aur.archlinux.org/packages/goread) via:\n\n```\n$ yay -S goread\n```\n\n```\n$ yay -S goread-bin # Release binary\n```\n\n## 📸 What does it look like?\n\nHere is a gif of some basic usage:\n\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"700\" src=\"assets/example1.gif\" /\u003e\n\u003c/p\u003e\n\nYou can use a colorscheme from `pywal` to create a goread colorscheme!\n\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"700\" src=\"assets/example2.gif\" /\u003e\n\u003c/p\u003e\n\n## ⚙️ Configuration\n\n### 📝 The urls file\n\nThe urls file contains the categories and feeds that you are subscribed to! This file is generated by the program in the config directory (usually `~/.config/goread/urls.yml`) and looks similar to this:\n\n```yaml\ncategories:\n  - name: News\n    desc: News from around the world\n    subscriptions:\n      - name: BBC\n        desc: News from the BBC\n        url: http://feeds.bbci.co.uk/news/rss.xml\n        blacklist_words:\n          - example\n  - name: Tech\n    desc: Tech news\n    subscriptions:\n      - name: Wired\n        desc: News from the wired team\n        url: https://www.wired.com/feed/rss\n      - name: Chris Titus Tech (virtualization)\n        desc: Chris Titus Tech on virtualization\n        url: https://christitus.com/categories/virtualization/index.xml\n        whitelist_words:\n          - qemu\n```\n\nYou can edit this file with `goread edit urls` to change the app's contents in an automated manner (remember that you can also edit entries in the TUI!).\n\n### 🌃 The colorscheme file\n\nThe colorscheme file contains the colorscheme of your application! It can be generated by hand or using\nthe `--dump_colors` flag. The colorscheme file is usually at `~/.config/goread/colorscheme.json` - here is how it looks like!\n\n```json\n{\n  \"bg_dark\": \"#161622\",\n  \"bg_darker\": \"#11111a\",\n  \"text\": \"#FFFFFF\",\n  \"text_dark\": \"#47485b\",\n  \"color1\": \"#c29fec\",\n  \"color2\": \"#ddbec0\",\n  \"color3\": \"#89b4fa\",\n  \"color4\": \"#e06c75\",\n  \"color5\": \"#98c379\",\n  \"color6\": \"#fab387\",\n  \"color7\": \"#f1c1e4\"\n}\n```\n\nYou can use the `--get_colors` flag to generate a colorscheme from pywal. For that you have to supply it with the pywal `colors.json` file which is usually located at `~/.cache/wal/colors.json`. To generate the `colors.json` file you can run `wal -stni ~/wallpapers/example.png`.\n\n### 📝 The config file\n\nYou can configure custom keybindings for goread in `goread.yml` in the same directory as the urls file, for an example use `goread edit config` which will open up the configuration in your favorite `$EDITOR`.\n\n## ✨ Contributing\n\nIf you have an idea or something doesn't work feel free to create an issue. If it is a bug remember to:\n\n- Update using `go install github.com/TypicalAM/goread@latest` or `homebrew upgrade`\n- Include output of `goread --version`\n- Include logs which are usually located at `/tmp/goread.log` on linux and `%TMP%\\goread.log` on Windows\n\nWhen running tests (for example when packaging) you can disable online tests by setting the env var `TEST_OFFLINE_ONLY` to a truthy value (for example \"YES\").\n\n## 💁 Credit where credit is due\n\n### Libraries\n\nThe demo was made using [vhs](https://github.com/charmbracelet/vhs/), which is an amazing tool, and you should definitely check it out. Other libraries included are:\n\n- [bubbletea](https://github.com/charmbracelet/bubbletea/) for runtime\n- [lipgloss](https://github.com/charmbracelet/lipgloss/) for styling\n- [cobra](https://github.com/spf13/cobra/) for flags\n- [gofeed](https://github.com/mmcdole/gofeed) for parsing xml feeds\n\n### Fonts \u0026 logo\n\nThe font in use for the logo is sen-regular designed by \"Philatype\" and licensed under Open Font License. The icon was designed by throwaway icons.\n\n=======\n\n### License\n\nCopyright (C) 2024 Adam Piaseczny\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with this program. If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypicalam%2Fgoread","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftypicalam%2Fgoread","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftypicalam%2Fgoread/lists"}