https://github.com/ma3ke/kreeftje
A terminal reader for lobste.rs
https://github.com/ma3ke/kreeftje
Last synced: about 2 months ago
JSON representation
A terminal reader for lobste.rs
- Host: GitHub
- URL: https://github.com/ma3ke/kreeftje
- Owner: ma3ke
- Created: 2022-07-09T21:45:18.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-02T14:42:44.000Z (over 2 years ago)
- Last Synced: 2025-02-13T10:17:57.083Z (4 months ago)
- Language: Rust
- Size: 387 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kreeftje 🦞
This is a little terminal reader for [lobste.rs](https://lobste.rs/). I love reading the site, so I made a little terminal user interface for it. This is not finished, but that does not matter.
## Installation
```zsh
git clone https://github.com/koenwestendorp/kreeftje
cd kreeftje
cargo install --path .
```
## Usage
_(Given that your `~/.cargo/bin/` is in your `$PATH`.)_
```zsh
kreeftje
```
Otherwise, running from the source directory would suffice too, of course.
```zsh
cargo run --release
```
### Key bindings
Within the program, the following key bindings can be used for navigation.
←, →, `h`, `l`
: Move between the stories list and comments view.
↓, ↑, `j`, `k`
: Select next and previous stories in the stories list page.
Move up and down in the comments view.
`J`, `K`
: Move to the next and previous page when in the stories list.
Move to the next and previous story when in the comments view.
`g`, `G`
: Move to the top and bottom of the stories list or comments view.
`o`, `Enter`
: Open the selected story in the browser.
(That browser will be the default browser for your system, and respects your `$BROWSER` environment variable. For further information, see the documentation of the [webbrowser](https://docs.rs/webbrowser/latest/webbrowser/) crate that is used under the hood.)
`q`, ``
: Quit the program.
## The name
The name 'kreeftje' is dutch for little lobster. Because my program is like a tiny version of the actual site, I think the name is cute and appropriate <3.
## Things I might implement
- [x] Ability to read comments associated with the stories. Comments can be accessed through a rightward motion (→ or `l`), and navigated in a separate view.
- [x] Tag coloring, just like on the site.
- [ ] Command line arguments to specify preferences.
- [ ] Config file abilities.
- [ ] Clear help and info.
- [ ] A way of 'selecting' stories, say by hitting the space bar, and then applying operations on them. Such operations could include saving stories, or opening them by bulk in the browser.
- [ ] API, rather than scraping the site??