Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrusme/canard
Canard. A command line TUI client for the journalist RSS aggregator.
https://github.com/mrusme/canard
canard cli command-line command-line-tool commandline commandline-interface commandline-tool journalist reader rss rss-reader terminal-based text-user-interface tui
Last synced: 29 days ago
JSON representation
Canard. A command line TUI client for the journalist RSS aggregator.
- Host: GitHub
- URL: https://github.com/mrusme/canard
- Owner: mrusme
- License: gpl-3.0
- Created: 2021-04-11T21:54:01.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-04T03:35:27.000Z (5 months ago)
- Last Synced: 2024-10-18T06:36:28.724Z (about 2 months ago)
- Topics: canard, cli, command-line, command-line-tool, commandline, commandline-interface, commandline-tool, journalist, reader, rss, rss-reader, terminal-based, text-user-interface, tui
- Language: Go
- Homepage: https://マリウス.com/canard-a-command-line-tui-client-for-the-journalist-rss-aggregator/
- Size: 340 KB
- Stars: 160
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- charm-in-the-wild - Canard - An RSS client. (_built with Bubble Tea_) (Applications / RSS and News)
README
# Canard
Canard. A command line TUI client for the
[Journalist](https://マリウス.com/journalist-an-rss-aggregator/) RSS aggregator.
](canard.jpg)
***Note: Canard is not compatible with Journalist v1.0.0 or newer and will soon
be merged into [Neon Modem Overdrive](https://github.com/mrusme/neonmodem)! Neon
Modem will support Journalist v1.0.0 and newer.***
## Installation
Download a binary from the [releases][releases] page.
Or build it yourself (requires Go 1.16+):
```bash
make
```
[releases]: https://github.com/mrusme/canard/releases
## User Manual
### Configuration
Export the following environment variables first:
```sh
export CANARD_API_URL="http://YOUR-JOURNALIST-SERVER:8000/fever/"
export CANARD_API_KEY="YOUR-JOURNALIST-API-KEY"
export GLAMOUR_STYLE="dark"
```
`CANARD_API_URL` and `CANARD_API_KEY` are
[Journalist](https://github.com/mrusme/journalist)-related configuration
parameters. `CANARD_API_KEY` is the Journalist `username:password` string as MD5
hash. If you're using Journalist in it's default configuration (`nobody:nobody`)
then you can simply set `CANARD_API_KEY` to `9a0f36d70a22b40baa26f3df113cd9eb`.
In case you have different users/passwords, run
`echo -n "username:password" | md5sum` to retrieve the hash.
`GLAMOUR_STYLE` defines how the articles are being rendered, see
[`glamour`](https://github.com/charmbracelet/glamour) for more info.
Please make sure you're running the latest version of `journalist`!
### Cheatsheet
#### Shortcuts
This is a list of supported keyboard shortcuts.
`ArrowUp` / `k`, `ArrowDn` / `j` \
Scroll list/reader in either direction by one line
`PgUp` / `b`, `PgDn` / `f` \
Scroll list/reader in either direction by one page
`u`, `d` \
Scroll list/reader in either direction by half a page
`g`, `G` \
Scroll list/reader to the very top/bottom
`q` \
While in reader, close reader; While in list, quit Canard
`Ctrl` + `R` \
Refresh feeds
`Ctrl` + `T` \
Open feed switcher
`Ctrl` + `Q` \
Quit Canard