https://github.com/pierreyoda/hncli

A Terminal User Interface-based application for browsing Hacker News, written in :crab: Rust.
https://github.com/pierreyoda/hncli

hackernews hackernews-cli hackernews-client rust terminal tui

Last synced: 3 months ago
JSON representation

A Terminal User Interface-based application for browsing Hacker News, written in :crab: Rust.

• Host: GitHub
• URL: https://github.com/pierreyoda/hncli
• Owner: pierreyoda
• License: mit
• Created: 2021-02-12T19:17:31.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T16:44:45.000Z (3 months ago)
• Last Synced: 2024-09-17T20:57:19.380Z (3 months ago)
• Topics: hackernews, hackernews-cli, hackernews-client, rust, terminal, tui
• Language: Rust
• Homepage:
• Size: 4.15 MB
• Stars: 22
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ratatui - hncli - Hacker News read-only TUI. (💻 Apps / 🌌 Other)

README

        
# hncli

A Terminal User Interface-based application for browsing Hacker News, written in 🦀 Rust.

## Screenshots

|                  Home Screen                  |                  Help Screen                  |

| :-------------------------------------------: | :-------------------------------------------: |

| ![home screen](./screenshots/home-screen.png) | ![help screen](./screenshots/help-screen.png) |

## Usage

### With the Rust toolchain

```sh

cargo run --release

```

### With Docker

```sh

docker build -t hncli .

docker run -it hncli

```

### Controls

After launching the application, use the arrow keys and 'Enter' to navigate and read the contextual help at the bottom of the screen (can be disabled from the settings screen).

There is a help screen, accessible in any screen by the key 'h', to guide you along.

## Caveats

- Expect bugs, some minor some rather critical but which should be rare, here and there in the current features scope.

- Really long posts or comments cannot be fully displayed yet.

- The control and shift key modifiers do not work properly in some cases.

- I have no access to hardware with smaller screens, so the terminal full screen experience may be compromised on such devices (should be good on 14" devices and more, depending on screen definition).

## Blog Posts

**The website itself is very Work In Progress**

- [An Hacker News Terminal UI: concept and road to release](https://www.newstackwhodis.com/blog/hncli-1-concept)

- [An Hacker News Terminal UI: deep-dive into the Rust architecture](https://www.newstackwhodis.com/blog/hncli-2-architecture)