A TUI client for Nostr

• Timeline
• Mention timeline
• Post, reply, react and repost
• Open per-user timelines as tabs
• Broadcast the currently playing track as a music status (NIP-38)

Dowonload binaries from the release page.

Or, install manually via crates.io:

cargo install nostui

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

pkgin install nostui

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

• Linux: ~/.config/nostui/config.json
• Windows: %LOCALAPPDATA%\0m1\nostui\config\config.json
• macOS: ~/Library/Application Support/io.0m1.nostui/config.json

2. Add your key to the config.json:

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

key takes an npub... instead for read-only mode, and relays is optional — without it nostui uses its own list.

"nip-38": { "enabled": true } is another key you can add. It broadcasts whatever you are playing as a NIP-38 status, to the relays above, where anyone can read it. It is off unless you write it.

Every example here is JSON, and each is one object: keys from more than one go together inside a single pair of braces rather than one block after another. Comments belong to config.json5, which is read as JSON5 — config.json is read as JSON, which has none.

nostui

Options:
  -h, --help     Print help
  -V, --version  Print version

You can override or add keybindings in your config file under keybindings.Home. Your settings are merged on top of the defaults, so you only need to list the keys you want to change.

{
    "keybindings": {
        "Home": {
            "<Ctrl-r>": "Repost",
            "<t>": "ScrollToTop"
        }
    }
}

The first of those binds another key to an action; the second rebinds one the defaults already use.

Each key is written between < and >. Modifiers are joined with - (e.g. <Ctrl-p>, <Shift-g>, <Alt-Enter>). Special keys such as up, down, home, end, esc, enter, tab and space are also supported.

The following actions are available:

For how the codebase is organised — the layers, their dependency direction, and the contracts between them — see docs/architecture.md.

Conventions the tooling does not check — commit messages, how tests are named and what they have to prove, the local checks before pushing — are in CONTRIBUTING.md.