https://github.com/vannrr/roboat
A rofi script written in Go for viewing feeds from newsboat.
https://github.com/vannrr/roboat
atom go golang newsboat rofi rofi-scripts rss
Last synced: 11 months ago
JSON representation
A rofi script written in Go for viewing feeds from newsboat.
- Host: GitHub
- URL: https://github.com/vannrr/roboat
- Owner: VannRR
- License: mit
- Created: 2024-10-15T03:38:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-15T03:45:08.000Z (over 1 year ago)
- Last Synced: 2025-03-30T08:28:38.508Z (11 months ago)
- Topics: atom, go, golang, newsboat, rofi, rofi-scripts, rss
- Language: Go
- Homepage:
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: newsboatdb/newsboatdb.go
- License: LICENSE
Awesome Lists containing this project
README
# Roboat
**Roboat** is a rofi script written in Go for viewing feeds from newsboat.
## Requirements
- A newsboat SQLite cache file (`cache.db`). You can set a custom path with the environment variable `$ROBOAT_CACHE_PATH`.
- Optionally, `xdg-utils` or you can set a browser with the environment variable `$ROBOAT_BROWSER`.
## Installation
### Build from source
1. Clone the repository:
```sh
git clone --depth 1 https://github.com/vannrr/roboat.git
cd roboat
```
2. Build Roboat:
- a.
```sh
make install
```
- b.
or if you don't have `make`:
```sh
go build -ldflags="-w -s" -o roboat main.go
mkdir -p ~/.config/rofi/scripts/
cp roboat ~/.config/rofi/scripts/
```
### Install from binary
1. Download from release page https://github.com/vannrr/roboat/releases/latest
2. place binary in `~/.config/rofi/scripts/`
## Usage
Run the script with rofi:
```sh
rofi -show roboat
```
### Notes
#### Hotkeys (Alt+1, etc.) Not Working
If hotkeys are not working in rofi, check the following properties in the rofi config:
`kb-custom-1`, `kb-custom-2`, and `kb-custom-3`. If they are not set to their default values,
the hotkeys listed in roboat will be incorrect.
## Links
- https://github.com/newsboat/newsboat
- https://github.com/davatorium/rofi
- https://github.com/lbonn/rofi (wayland fork)
- https://github.com/davatorium/rofi/blob/next/doc/rofi-script.5.markdown
## License
This project is licensed under the MIT License. See the LICENSE file for details.