{"id":14529771,"url":"https://github.com/mrusme/canard","last_synced_at":"2025-04-10T23:40:37.340Z","repository":{"id":37712903,"uuid":"356987767","full_name":"mrusme/canard","owner":"mrusme","description":"Canard. A command line TUI client for the journalist RSS aggregator.","archived":false,"fork":false,"pushed_at":"2024-07-04T03:35:27.000Z","size":348,"stargazers_count":160,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-18T06:36:28.724Z","etag":null,"topics":["canard","cli","command-line","command-line-tool","commandline","commandline-interface","commandline-tool","journalist","reader","rss","rss-reader","terminal-based","text-user-interface","tui"],"latest_commit_sha":null,"homepage":"https://マリウス.com/canard-a-command-line-tui-client-for-the-journalist-rss-aggregator/","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":"2021-04-11T21:54:01.000Z","updated_at":"2024-09-20T17:28:55.000Z","dependencies_parsed_at":"2024-06-19T00:27:52.837Z","dependency_job_id":"730f5321-932e-4137-873d-fb13a92fa77f","html_url":"https://github.com/mrusme/canard","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Fcanard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Fcanard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Fcanard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrusme%2Fcanard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrusme","download_url":"https://codeload.github.com/mrusme/canard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248317732,"owners_count":21083525,"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":["canard","cli","command-line","command-line-tool","commandline","commandline-interface","commandline-tool","journalist","reader","rss","rss-reader","terminal-based","text-user-interface","tui"],"created_at":"2024-09-05T00:01:02.254Z","updated_at":"2025-04-10T23:40:37.320Z","avatar_url":"https://github.com/mrusme.png","language":"Go","funding_links":["https://github.com/mrusme#support"],"categories":["Applications","\u003ca name=\"rss\"\u003e\u003c/a\u003eRSS","Table of Contents"],"sub_categories":["RSS, News and Weather"],"readme":"# Canard\n\nCanard. A command line TUI client for the \n[Journalist](https://マリウス.com/journalist-an-rss-aggregator/) RSS aggregator.\n\n![[Canard](https://player.vimeo.com/video/535676709)](canard.jpg)\n\n***Note: Canard is not compatible with Journalist v1.0.0 or newer and will soon \nbe merged into [Neon Modem Overdrive](https://github.com/mrusme/neonmodem)! Neon \nModem will support Journalist v1.0.0 and newer.***\n\n\n## Installation\n\nDownload a binary from the [releases][releases] page.\n\nOr build it yourself (requires Go 1.16+):\n\n```bash\nmake\n```\n\n[releases]: https://github.com/mrusme/canard/releases\n\n\n## User Manual\n\n\n### Configuration\n\nExport the following environment variables first:\n\n```sh\nexport CANARD_API_URL=\"http://YOUR-JOURNALIST-SERVER:8000/fever/\"\nexport CANARD_API_KEY=\"YOUR-JOURNALIST-API-KEY\"\nexport GLAMOUR_STYLE=\"dark\"\n```\n\n`CANARD_API_URL` and `CANARD_API_KEY` are \n[Journalist](https://github.com/mrusme/journalist)-related configuration\nparameters. `CANARD_API_KEY` is the Journalist `username:password` string as MD5\nhash. If you're using Journalist in it's default configuration (`nobody:nobody`)\nthen you can simply set `CANARD_API_KEY` to `9a0f36d70a22b40baa26f3df113cd9eb`.\nIn case you have different users/passwords, run \n`echo -n \"username:password\" | md5sum` to retrieve the hash.\n\n`GLAMOUR_STYLE` defines how the articles are being rendered, see \n[`glamour`](https://github.com/charmbracelet/glamour) for more info.\n\nPlease make sure you're running the latest version of `journalist`!\n\n\n### Cheatsheet\n\n\n#### Shortcuts\n\nThis is a list of supported keyboard shortcuts.\n\n`ArrowUp` / `k`, `ArrowDn` / `j` \\\nScroll list/reader in either direction by one line\n\n`PgUp` / `b`, `PgDn` / `f` \\\nScroll list/reader in either direction by one page\n\n`u`, `d` \\\nScroll list/reader in either direction by half a page\n\n`g`, `G` \\\nScroll list/reader to the very top/bottom\n\n`q` \\\nWhile in reader, close reader; While in list, quit Canard\n\n`Ctrl` + `R` \\\nRefresh feeds\n\n`Ctrl` + `T` \\\nOpen feed switcher\n\n`Ctrl` + `Q` \\\nQuit Canard\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrusme%2Fcanard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrusme%2Fcanard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrusme%2Fcanard/lists"}