mrusme / neonmodem

Neon Modem Overdrive
https://neonmodem.com
GNU General Public License v3.0
534 stars 22 forks source link
api api-client ascii-art bbs bulletin-board bulletin-board-system bulletinboard cli command-line command-line-tool discourse discourse-api forum forum-application hacker-news hackernews lemmy terminal terminal-app tui

Neon Modem Overdrive

Chat on Matrix

Neon Modem Overdrive

Neon Modem Overdrive is a BBS-style command line client that supports Discourse, Lemmy, Lobsters and Hacker News as backends, and seamlessly integrates all of them into a streamlined TUI. And yes, you heard that right, I really did call it Neon Modem Overdrive.

Neon Modem is built in Go, using Charm's Bubble Tea TUI framework, but implements an own window manager (or compositor if you want) that allows it to use a third dimension, on top of the two dimensional rendering that Bubble Tea offers today. With that it is possible to display dialogs on top of one another, in order to offer a smoother UI experience.

More info here!

Support

System Available List Forums List Posts List Replies Create Post Create Reply
Discourse :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
Lemmy :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
Lobsters :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
Hacker News :heavy_check_mark: :heavy_check_mark: :heavy_check_mark: :heavy_check_mark:
RSS+Disqus/Isso(?)
Superhighway84
NNTP

Installation

From Release

Download the latest release and unpack it:

$ tar -xzf ./neonmodem_*.tar.gz

The binary is called neonmodem. Feel free to move it to e.g. /usr/local/bin.

From Sauce

Clone this repository

Then cd into the cloned directory and run:

make

The binary is called neonmodem. Feel free to move it to e.g. /usr/local/bin.

For Arch Linux an AUR package is available here: https://aur.archlinux.org/packages/neonmodem

Install with your favorite AUR helper.

On NetBSD, a package is available from the official repositories. To install it, simply run pkgin install neonmodem.

Configuration

Before launching Neon Modem Overdrive it requires initial setup of the services (a.k.a. systems). Run neonmodem connect --help to find out more.

Connecting a service will add it to the configuration TOML.

Linux/Unix

~/.config/neonmodem.toml

MacOS

$HOME/Library/Application\ Support/neonmodem.toml

Systems

Discourse

For connecting to a Discourse instance you'll need to have an active account on that instance. Neon Modem will store the instance URL, username and a user key, but no password.

neonmodem connect --type discourse --url https://www.keebtalk.com

Lemmy

For connecting to a Lemmy instance you'll need to have an active account on that instance. Neon Modem will store the instance URL, username and password.

neonmodem connect --type lemmy --url https://lemmy.ml

Lobsters

For connecting to a Lobsters instance you won't need an account, as the integration is read-only. Neon Modem will store the instance URL.

neonmodem connect --type lobsters --url https://lobste.rs

Hacker News

For connecting to Hacker News you won't need an account, as the integration is read-only.

neonmodem connect --type hackernews

UI

The UI can be fully customized via the Theme section in the configuration file. To reset settings, all theme related configurations can simply be deleted from the configuration.

Run

After setup Neon Modem can be launched by calling neonmodem without any arguments. It will briefly display a splash screen, then switch to the posts list, which will aggregate the latest posts from all connected systems. A progress icon will be visible in the header while network requests are loading.

Usage

Neon Modem Overdrive

Navigation

In the posts list:

In the post view dialog:

In the new post / new reply dialog:

FAQ