1 unstable release
0.1.0 | Jan 14, 2024 |
---|
#50 in #nostr
1.5MB
3K
SLoC
nostui
A TUI client for Nostr
Current features
- Timeline
- Post, Reply, Reaction, Repost
Getting Started
Requirements
- git
- rust
Installation
- Clone this repository and move to the directory:
git clone https://github.com/akiomik/nostui
cd nostui
- Install
nostui
binary:
# Install to ~/.cargo/bin/nostui
cargo install --path .
Setup
[!NOTE] Other extensions supported are
.json5
,.yaml
,.toml
and.ini
.
- 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
- 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
Keybinding | Description |
---|---|
k up |
Scroll up |
j down |
Scroll down |
q Ctrl-c Ctrl-d |
Quit |
home g |
Scroll to top |
end Shift-g |
Scroll to bottom |
Ctrl-z |
Suspend |
esc |
Unselect |
n |
New text note |
Ctrl-p |
Submit text note |
r |
Reply to the selected note |
f |
Send reaction |
t |
Repost |
Dependencies
~40–57MB
~895K SLoC