{"id":13477777,"url":"https://github.com/veeso/tuifeed","last_synced_at":"2025-05-16T10:06:44.460Z","repository":{"id":45927786,"uuid":"425467474","full_name":"veeso/tuifeed","owner":"veeso","description":"📰 A terminal feed reader with a fancy ui","archived":false,"fork":false,"pushed_at":"2025-03-30T14:07:07.000Z","size":4017,"stargazers_count":144,"open_issues_count":0,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-08T06:48:37.557Z","etag":null,"topics":["command-line-interface","command-line-utilities","command-line-utility","feed","feed-reader","rss","rust","rust-crate"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/veeso.png","metadata":{"funding":{"github":"veeso","ko_fi":"veeso"},"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-11-07T10:01:10.000Z","updated_at":"2025-04-22T07:58:39.000Z","dependencies_parsed_at":"2025-04-06T14:11:48.782Z","dependency_job_id":"0ff24862-bee1-46d4-8e19-48503d283780","html_url":"https://github.com/veeso/tuifeed","commit_stats":{"total_commits":55,"total_committers":4,"mean_commits":13.75,"dds":0.07272727272727275,"last_synced_commit":"f3c8f2d0f377729c2bf58ea799408dde1cb23579"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veeso%2Ftuifeed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veeso%2Ftuifeed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veeso%2Ftuifeed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/veeso%2Ftuifeed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/veeso","download_url":"https://codeload.github.com/veeso/tuifeed/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254509476,"owners_count":22082891,"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":["command-line-interface","command-line-utilities","command-line-utility","feed","feed-reader","rss","rust","rust-crate"],"created_at":"2024-07-31T16:01:47.444Z","updated_at":"2025-05-16T10:06:44.435Z","avatar_url":"https://github.com/veeso.png","language":"Rust","funding_links":["https://github.com/sponsors/veeso","https://ko-fi.com/veeso","https://www.paypal.me/chrisintin"],"categories":["Rust"],"sub_categories":[],"readme":"# tuifeed\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"/docs/images/tuifeed.svg\" width=\"256\" height=\"256\" alt=\"logo\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e~ A terminal news feed reader with a fancy ui ~\u003c/p\u003e\n\n\u003cp align=\"center\"\u003eDeveloped by \u003ca href=\"https://veeso.me/\" target=\"_blank\"\u003e@veeso\u003c/a\u003e\u003c/p\u003e\n\u003cp align=\"center\"\u003eCurrent version: 0.4.2 (30/03/2025)\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://opensource.org/licenses/MIT\"\n    \u003e\u003cimg\n      src=\"https://img.shields.io/badge/License-MIT-teal.svg\"\n      alt=\"License-MIT\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/veeso/tuifeed/stargazers\"\n    \u003e\u003cimg\n      src=\"https://img.shields.io/github/stars/veeso/tuifeed.svg?style=badge\u0026logo=github\"\n      alt=\"Repo stars\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://crates.io/crates/tuifeed\"\n    \u003e\u003cimg\n      src=\"https://img.shields.io/crates/d/tuifeed.svg\"\n      alt=\"Downloads counter\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://crates.io/crates/tuifeed\"\n    \u003e\u003cimg\n      src=\"https://img.shields.io/crates/v/tuifeed.svg\"\n      alt=\"Latest version\"\n  /\u003e\u003c/a\u003e\n  \u003ca href=\"https://ko-fi.com/veeso\"\u003e\n    \u003cimg\n      src=\"https://img.shields.io/badge/donate-ko--fi-red\"\n      alt=\"Ko-fi\"\n  /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/veeso/tuifeed/actions\"\n    \u003e\u003cimg\n      src=\"https://github.com/veeso/tuifeed/workflows/build_test/badge.svg\"\n      alt=\"Linux CI\"\n  /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\n- [tuifeed](#tuifeed)\n  - [About tuifeed 📰](#about-tuifeed-)\n    - [Features 🎁](#features-)\n  - [Get started 🏁](#get-started-)\n    - [Installation 🚀](#installation-)\n      - [Shell script 🖥️](#shell-script-️)\n      - [FreeBSD users](#freebsd-users)\n      - [Windows users 🍫](#windows-users-)\n      - [Cargo installation 📦](#cargo-installation-)\n    - [Configure your news feed](#configure-your-news-feed)\n    - [Configure your display options](#configure-your-display-options)\n  - [Keybindings ⌨️](#keybindings-️)\n  - [Support the developer ☕](#support-the-developer-)\n  - [Powered by 💪](#powered-by-)\n  - [Contributing and issues 🤝🏻](#contributing-and-issues-)\n  - [Changelog ⏳](#changelog-)\n  - [License 📃](#license-)\n\n---\n\n## About tuifeed 📰\n\ntuifeed is a news feed reader with a fancy terminal user interface. It allows you read news from your favourite RSS and Atom sources, which can be easily configured in a TOML file.\n\n![Demo](/docs/images/demo.gif)\n\n### Features 🎁\n\n- 📰 Read feed from any RSS/Atom source\n- 🌐 Open any article in your favourite browser in one-click\n- 🐧 Compatible with Windows, Linux, *BSD and MacOS\n- 🤖 Easy setup\n- 🦀 Rust-powered\n\n---\n\n## Get started 🏁\n\n### Installation 🚀\n\n#### Shell script 🖥️\n\n```sh\ncurl --proto '=https' --tlsv1.2 -sSLf \"https://git.io/J1O0Z\" | sh\n```\n\n⚠️ this method is supported for the following operating systems:\n\n- 🐧 **GNU/Linux**\n- 🍎 **MacOS**\n- 🚩 **NetBSD**\n\n\u003e 🔴 If you don't trust the script, you can view its content [on Github](https://github.com/veeso/tuifeed/blob/main/install.sh)\n\n#### FreeBSD users\n\nInstall via pkg:\n\n```sh\npkg install tuifeed\n```\n\n#### Windows users 🍫\n\nInstall via [Chocolatey](https://chocolatey.org/):\n\n```ps1\nchoco install tuifeed\n```\n\n#### Cargo installation 📦\n\n```sh\ncargo install --locked tuifeed\n```\n\n---\n\n### Configure your news feed\n\nOnce installed, in order to start using tuifeed, the first thing you need to do is to configure the feeds you want to read from.\n\nTo open the configuration file you can run\n\n```sh\ntuifeed -c\n```\n\nthis will open the configuration file in your favourite editor.\n\n\u003e 💡 If this option doesn't work for you, you can edit the file manually at:\n\u003e\n\u003e - `$XDG_CONFIG_HOME/tuifeed/config.toml` on Linux\n\u003e - `/Users/$USER/Library/Application\\ Support/tuifeed/config.toml` on MacOS\n\nthen you can add new sources as follows:\n\n```toml\n[sources]\n\"Cointelegraph\" = \"https://it.cointelegraph.com/rss\"\n\"Corriere Della Sera\" = \"http://xml2.corriereobjects.it/rss/homepage.xml\"\n\"Friuli Oggi\" = \"https://www.friulioggi.it/feed/\"\n\"Il Piccolo\" = \"https://ilpiccolo.gelocal.it/rss/finegil/ilpiccolo/feed.rss\"\n\"Il Post (Mondo)\" = \"https://www.ilpost.it/mondo/feed/\"\n\"Il Post (Italia)\" = \"https://www.ilpost.it/italia/feed/\"\n\"Messaggero Veneto\" = \"https://messaggeroveneto.gelocal.it/rss/finegil/messaggeroveneto/feed.rss\"\nlocal = \"file:///path/to/your/local/feed.xml\"\n```\n\nso for each feed you want to read from, you must put an entry with a key, which identifies the **Name** of the source as it'll be displayed in the UI associated to the URL of the feed.\n  \n\u003e 💡 If you want to use special characters in toml you can quote the key name:\n\u003e `\"Il Post (Mondo)\" = \"https://www.ilpost.it/mondo/feed/\"`\n\nOnce you're done with configuration, save, close and enjoy tuifeed 😄\n\n### Configure your display options\n\nYou can optionally configure some display options in the UI.\n\nTo open the configuration file you can run\n\n```sh\ntuifeed -c\n```\n\nthis will open the configuration file in your favourite editor.\n\n\u003e 💡 If this option doesn't work for your, you can edit the file manually at:\n\u003e\n\u003e - `$XDG_CONFIG_HOME/tuifeed/config.toml` on Linux\n\u003e - `/Users/$USER/Library/Application\\ Support/tuifeed/config.toml` on MacOS\n\nThen you can configure the following keys\n\n```toml\n[article-title]\nshow-author = false\nshow-timestamp = true\n```\n\n- show-author: display the author name before the article title in the articles list\n- show-timestamp: display the timestamp before the article title in the articles list\n\nThe key order in the article list name is:\n\n1. timestamp\n2. author\n3. title\n\nOnce you're done with configuration, save, close and enjoy tuifeed 😄\n\n---\n\n## Keybindings ⌨️\n\n| Key                              | Where                           | Description                                         |\n|----------------------------------|---------------------------------|-----------------------------------------------------|\n| Tab, Right                       | Feed list                       | Move to article list                                |\n| Up, Down, PageUp, PageDown       | Feed list, article list         | Scroll up/down in list                              |\n| Home, End                        | Feed list, article list         | Go to the beginning/end of the list                 |\n| R                                | Feed list                       | Reload selected source                              |\n| CTRL+R                           | Feed list                       | Reload all sources                                  |\n| V                                | Feed list                       | Mark selected source as read                        |\n| CTRL+V                           | Feed list                       | Mark all sources as read                            |\n| Tab, Left                        | Article list                    | Move to feed list                                   |\n| Right                            | Article list                    | Move to article summary                             |\n| Left                             | Article summary                 | Move to article list                                |\n| Up, Down, PageUp, PageDown       | Article summary                 | Scroll up/down in summary                           |\n| Home, End                        | Article summary                 | Go to the beginning/end of summary                  |\n| Enter                            | Article summary, article link   | Open selected article url in your favourite browser |\n| Esc                              | *                               | Quit tuifeed                                        |\n\n---\n\n## Support the developer ☕\n\nIf you like tuifeed and you're grateful for the work I've done, please consider a little donation 🥳\n\nYou can make a donation with one of these platforms:\n\n[![ko-fi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge\u0026logo=ko-fi\u0026logoColor=white)](https://ko-fi.com/veeso)\n[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge\u0026logo=paypal\u0026logoColor=white)](https://www.paypal.me/chrisintin)\n\n---\n\n## Powered by 💪\n\n- [crossterm](https://github.com/crossterm-rs/crossterm)\n- [feed-rs](https://github.com/feed-rs/feed-rs)\n- [ratatui](https://github.com/ratatui/ratatui)\n- [tui-realm](https://github.com/veeso/tui-realm)\n- [ureq](https://github.com/algesten/ureq)\n\n---\n\n## Contributing and issues 🤝🏻\n\nContributions, bug reports, new features and questions are welcome! 😉\nIf you have any question or concern, or you want to suggest a new feature, or you want just want to improve tuifeed, feel free to open an issue or a PR.\n\nPlease follow [our contributing guidelines](CONTRIBUTING.md)\n\n---\n\n## Changelog ⏳\n\nView tuifeed's changelog [HERE](CHANGELOG.md)\n\n---\n\n## License 📃\n\ntuifeed is licensed under the MIT license.\n\nYou can read the entire license [HERE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveeso%2Ftuifeed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fveeso%2Ftuifeed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fveeso%2Ftuifeed/lists"}