An open API service indexing awesome lists of open source software.

https://github.com/harryfrzz/re-tui

Re-TUI is a fast and lightweight terminal-based Reddit client written in Go. It lets you browse subreddits and read discussions directly from your command line with a clean interface.
https://github.com/harryfrzz/re-tui

bubbletea go golang reddit-api

Last synced: 5 months ago
JSON representation

Re-TUI is a fast and lightweight terminal-based Reddit client written in Go. It lets you browse subreddits and read discussions directly from your command line with a clean interface.

Awesome Lists containing this project

README

          

# Re-TUI

**Re-TUI** is a fast and lightweight terminal-based Reddit client written in Go.
It lets you browse subreddits and read discussions directly from your command line with a clean interface.

Perfect for anyone who prefers using the terminal for everyday browsing.

## Installation

### Prerequisites

* **Go 1.21+** (Ensure you have a recent version of Go installed)
* Terminal with TrueColor support (recommended).

### Install via npm

You can install `re-tui` using npm:

```bash
npm install -g re-tui
```

## Keybindings

**Re-TUI** uses intuitive, Vim-inspired keybindings for navigation.

| Key | Action |
| --- | --- |
| `j` / `↓` | Move selection down |
| `k` / `↑` | Move selection up |
| `l` / `Enter` | Open post / Expand comment |
| `h` / `Esc` | Go back / Collapse comment |
| `u` | Upvote |
| `d` | Downvote |
| `q` | Quit application |

> **Note:** Keybindings can be customized in the configuration file (Feature to be added in future updates).
## Contributing

Contributions are welcome! If you have a feature request or want to report a bug, please open an issue.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=harryfrzz/re-tui&type=date&legend=top-left)](https://www.star-history.com/#harryfrzz/re-tui&type=date&legend=top-left)
---

## License

Under the GPL 3.0 License. See `LICENSE` for more information.