nostui

A TUI client for Nostr

Current features

• Timeline
• Post, Reply, Reaction, Repost

Getting Started

Requirements

• git
• rust

Installation

1. Clone this repository and move to the directory:

git clone https://github.com/akiomik/nostui
cd nostui

2. Install nostui binary:

# Install to ~/.cargo/bin/nostui
cargo install --path .

Setup

[!NOTE] Other extensions supported are .json5, .yaml, .toml and .ini.

1. Create a config.json to the following path:

• Linux: ~/.config/notsui/config.json
• Windows: ~\AppData\Roaming\0m1\nostui\config.json
• macOS: ~/Library/Application Support/io.0m1.nostui/config.json

2. Add your privatekey to the config.json:

{
    "privatekey": "nsec1...",
    "relays": ["wss://nos.lol"] // optional
}

Usage

Commands

nostui [OPTIONS]

Options:
  -t, --tick-rate <FLOAT>   Tick rate, i.e. number of ticks per second [default: 16]
  -f, --frame-rate <FLOAT>  Frame rate, i.e. number of frames per second [default: 16]
  -h, --help                Print help
  -V, --version             Print version

Default Keybindings