Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blakejakopovic/nostcat
Websocket client for nostr relay scripting
https://github.com/blakejakopovic/nostcat
cli nostr nostr-protocol rust websocat websocket
Last synced: 26 days ago
JSON representation
Websocket client for nostr relay scripting
- Host: GitHub
- URL: https://github.com/blakejakopovic/nostcat
- Owner: blakejakopovic
- License: mit
- Created: 2022-11-16T20:28:12.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-24T12:57:24.000Z (7 months ago)
- Last Synced: 2024-05-17T12:02:59.944Z (about 1 month ago)
- Topics: cli, nostr, nostr-protocol, rust, websocat, websocket
- Language: Rust
- Homepage:
- Size: 90.8 KB
- Stars: 94
- Watchers: 3
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-nostr - nostcat - cat-like nostr client for scripting and debugging written in Rust (Tools / Client reviews and/or comparisons)
README
# nostcat
[](https://crates.io/crates/nostcat)
[](https://crates.io/crates/nostcat)
[](https://github.com/blakejakopovic/nostcat/blob/master/LICENSE)
Websocket client command line tool for nostr relay scripting, with docker and tor support
## Examples
Using interactive input
```shell
$ nostcat wss://relay.damus.io
["REQ", "RAND", {"kinds": [1], "limit": 8}]
```
Using stdin (supports multiple lines of commands)
```shell
$ echo '["REQ", "RAND", {"kinds": [1], "limit": 8}]' |
nostcat wss://relay.damus.io
$ cat commands.txt
["REQ", "RAND", {"kinds": [1], "limit": 2}]
["REQ", "RAND2", {"kinds": [2], "limit": 2}]
$ cat commands.txt | nostcat wss://relay.damus.io
```
Using jq to query Nostr JSON events and select the event JSON
```shell
$ echo '["REQ", "RAND", {"kinds": [1], "limit": 8}]' |
nostcat wss://relay.damus.io |
jq '.[2]'
$ echo '["REQ", "RAND", {"kinds": [1], "limit": 8}]' |
nostcat wss://relay.damus.io |
jq '.[2].content'
```
Unique (dedupe) results as they come in (note: no longer applies sorting events - FIFO)
```shell
$ echo '["REQ", "RAND", {"kinds": [1], "limit": 8}]' |
nostcat --unique wss://relay.damus.io wss://nostr.ono.re
```
With a websocket connection timeout in milliseconds
```shell
$ echo '["REQ", "RAND", {"kinds": [1], "limit": 2}]' |
nostcat --connect-timeout 250 wss://relay.damus.io
```
Stream websocket data (like tail -f)
```shell
$ echo '["REQ", "RAND", {"kinds": [1], "limit": 8}]' |
nostcat --stream wss://relay.damus.io
```
Output info log messages which can assist with debugging
```shell
$ echo '["REQ", "RAND", {"kinds": [1], "limit": 8}]' |
RUST_LOG=info nostcat wss://relay.damus.io
```
Pipe events from one server to another (currently limited to 1 event at a time)
```shell
$ echo '["REQ", "RAND", {"limit": 1}]' |
nostcat wss://relay.damus.io |
jq -c 'del(.[1])' |
nostcat wss://nostr.ono.re
```
Pipe events from one server to another (for multiple events, `ctrl-C` when finished)
```shell
$ echo '["REQ", "RAND", {"limit": 3}]' |
nostcat wss://relay.damus.io |
jq -c 'del(.[1])' |
nostcat --stream wss://nostr.ono.re
```
## Getting started
Using Cargo to install (requires ~/.cargo/bin to be in PATH)
```shell
$ cargo install nostcat
```
Building from source (may be unstable)
```shell
$ git clone https://github.com/blakejakopovic/nostcat
$ cargo build --release
```
Running inside a Docker image
```shell
$ docker build -t nostcat .
# Run the the docker image as an executable
$ echo '["REQ", "RAND", {"kinds": [1], "limit": 2}]' | docker run --rm -i nostcat wss://relay.damus.io
```