Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/0xtrr/nostr-tool
A simple CLI to send nostr events
https://github.com/0xtrr/nostr-tool
cli hacktoberfest nostr rust tool
Last synced: 26 days ago
JSON representation
A simple CLI to send nostr events
- Host: GitHub
- URL: https://github.com/0xtrr/nostr-tool
- Owner: 0xtrr
- License: mit
- Created: 2022-11-08T18:48:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-05T10:22:24.000Z (10 months ago)
- Last Synced: 2024-05-16T09:22:26.086Z (about 1 month ago)
- Topics: cli, hacktoberfest, nostr, rust, tool
- Language: Rust
- Homepage:
- Size: 139 KB
- Stars: 51
- Watchers: 5
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-nostr - nostr-tool - tool.svg?style=social) - Rust CLI tool to generate and publish events (Tools / Client reviews and/or comparisons)
- Self-Hosting-Guide - nostr-tool - A Rust CLI tool to generate and publish events. (Install from Source / Nostr)
README
# Nostr-tool
[](https://crates.io/crates/nostr-tool)
[](https://crates.io/crates/nostr-tool)
[](https://hub.docker.com/r/0xtr/nostr-tool)
[](LICENSE)
A simple CLI tool to send nostr events.
Currently, this is more of a POC on the use of the [nostr-sdk](https://github.com/rust-nostr/nostr) library in a CLI
application.
## Install
Clone the repo and run the following command in the repo folder. You must have Rust installed to compile this.
### Install from crates.io
```shell
cargo install nostr-tool
```
### Build from source
```shell
cargo build --release
```
### Build with Docker locally
```shell
docker build -t nostr-tool .
```
### Build with Docker from DockerHub
```shell
docker pull 0xtr/nostr-tool:0.3.0
```
Run `nostr-tools` command once to get the standard help menu up. Each subcommand also has it's own help menu accessed by appending the --help flag.
## Examples
### Update metadata
```shell
nostr-tool -r wss://nostr.oxtr.dev update-metadata -n "Alice" -a "Who the fuck is Alice?" -p "https://upload.wikimedia.org/wikipedia/en/2/2b/New_world-living_next_door_to_alice.JPG"
```
### Create a new note with a new identity
```shell
nostr-tool -r wss://nostr.oxtr.dev text-note -c "Hello World"
```
### Create a new note with an existing private key
```shell
nostr-tool -r wss://nostr.oxtr.dev -p {PRIVATE_KEY} text-note -c "Hello World"
```
### Create a new note with an existing private key as a reply to another note
```shell
nostr-tool -r wss://nostr.oxtr.dev -p {PRIVATE_KEY} text-note -c "Hello World" --etag {EVENT-ID_TO_REPLY_TO} --ptag {PUBKEY_YOU_ARE_REPLYING_TO}
```
### Import contacts/followers from a CSV file
```shell
nostr-tool -r wss://nostr.oxtr.dev -p {PRIVATE_KEY} publish-contact-list-csv -f {PATH_TO_CSV_FILE}
```
The CSV file should have the following format
```csv
pubkey,relay,petname
b2d670de53b27691c0c3400225b65c35a26d06093bcc41f48ffc71e0907f9d4a,"wss://nostr.oxtr.dev",""
32e1827635450ebb3c5a7d12c1f8e7b2b514439ac10a67eef3d9fd9c5c68e245,"wss://relay.damus.io",""
```
### Send a direct message
```shell
nostr-tool -r wss://nostr.oxtr.dev -p {PRIVATE_KEY} send-direct-message --receiver {RECIPIENT_PUBKEY} --message "Hello World"
```
### Delete an event
```shell
nostr-tool -r wss://nostr.oxtr.dev -p {PRIVATE_KEY} delete-event -e {EVENT_ID} -r "The reason for deleting the event"
```
### React to an event
```shell
nostr-tool -r wss://nostr.oxtr.dev -p {PRIVATE_KEY} react -e {EVENT_ID} -a {EVENT_AUTHOR_PUBKEY} -r "👍"
```
### Run with docker
```shell
docker run nostr-tool nostr-tool -r wss://nostr.oxtr.dev text-note -c "Hello World"
```