0xtrr / nostr-tool

A simple CLI to send nostr events

Nostr-tool

A CLI tool to make it simple to specific send nostr events.

Install

Installation instructions can be found in INSTALL.md.

Usage

Run nostr-tool -h to see available options and subcommands. To get help with the sub commands, run nostr-tool [subcommand] -h, e.g. nostr-tool text-note -h. More examples can be found in EXAMPLES.md.

Contributions

Contributions are always welcome! If you find something the CLI is missing, a PR is very appreciated. If you can't develop it yourself, please make an issue for it so that me or someone else can take a stab at it.

Thank you for your contributions! Your help is greatly appreciated.

nostr-tool's Issues

feat: Add response message

It would be nice to have response from server when an event is send, usually ["OK","EVENTID",true,""] when note is send succesfully.
Using websocat and nostril , that's what i get.

Or i get :

Sent event EVENTID to 'wss://relay.nostr.band'.
Seen EVENTID on 'wss://relay.nostr.band'.

when using noscl.

This let me know that the message was succesfully accepted by the server and the event id so I can look at it later if i need to.
I know you already give:

Public key:
Private key:

back . Wich i think is nice.

What do you think?

Publish package to crates.io

Publish this binary to crates.io so that it's easy to install and start to use.

feat: Set LUD-06 in update-metadata command

Users should be able to set their LUD-06 in the update-metadata command. Currently we're using nostr_rust's set_metadata function but it does not have support for this field so we probably need to manually handle this type of event. Or we could implement support for it in nostr_rust.

feature: Add support for NIP-49

I want to be able to import and export (decrypt/encrypt) my privatekeys.

NIP-49.

feat: Generate a new keypair

The user should be able to just generate a new keypair. Might be helpful when testing new clients or when you want to generate a temporary anon keypair. Users will be able to generate keypairs easily offline too.

feat: Add support for bech32 encoded keys in the commands

Currently you can only use the hex private key when using this tool. We should accept both hex and bech32 encoded priv keys.

Should just be to see if the key starts with 'nsec' and if so, decode it to hex.

doc: Move examples out of readme and into it's own examples file

I'm not even sure I want to keep the examples at all as the help menu should provide enough documentation for the user. If we keep it, it should be moved into it's own file so that it doesn't take up so much space in the readme.

Upgrade nostr-sdk to 0.22

feat: Update nostr_rust dependency to latest version

feat: Add bech32/hex conversion for keys and notes

Add support for encoding hex public keys, private keys and note ids to bech32 and vice versa. Tools such as key-convertr already has this but we should support it in nostr-tool as well.

Request: Add some topics to this repo

Just discovered this repo by searching the domains of public nostr relays. Would you be open to adding the nostr topic to the repo? That would make it easier for folks to discover the repo on GitHub.

I'm browsing around the nostr landscape trying to get a sense of what's happening in the space, so I noticed that this repo didn't show up when I was looking at the topic here https://github.com/topics/nostr

NIP-14: Add subject tag to note events

We should add the option of a subject tag in text notes. Functionality is described in NIP-14.

feat: Send to channels

Hey, it would be nice to be able to send messages to channels kind 42.

Arbitrary fields in metadata events

Should we enable arbitrary fields in the metadata? This will not follow the existing protocol spec I believe but the LUD related fields are not a part NIP-01 either but are still well established in existing clients for use with e.g. in NIP-57 (Bitcoin Lightning zaps).

feature: Print bech32 encoded "nchannel" for kind 40 events

There is a PR for adding nchannel to NIP-19. We should implement this here.

We probably want to print the following values:
Bech32 encoded note id
Bech32 encoded nchannel id
Hex encoded event id

delete-profile doesn't work

I just get an error message that the command doesn't work, and a suggestion to use delete-event, instead.

feat: Add flag to fetch user relays

I think it would make it easier to e.g. delete events if we just fetched all user relays. Should probably be exposed as it's own flag at the root level of the command.
So instead of doing
nostr-tool -r wss://nostr.oxtr.dev -p {PRIVATE_KEY} delete-event -e {EVENT_ID} -r "The reason for deleting the event"
we could do:
nostr-tool -ur -p {PRIVATE_KEY} delete-event -e {EVENT_ID} -r "The reason for deleting the event"
where the -ur flag is short for "user relays" or something similar.

feat: import/export contacts and relays

Let the user export existing contacts and relays to CSV files and likewise import from the same CSV file. Nostr-tool already has support for importing contact list from CSV but you'd have to manually create the file yourself.

feature: Zap support

I have not done too much thinking about this but adding it so I, or someone else, can take a look at it later. Does it make sense to support Zaps in nostr-tool?

NIP-19: Add support for encoding/decoding nprofiles

feature: Export all events from a specific public key

A convenience command to export everything you've written to a specific relay. This could make it easier to move from a relay you've been kicked off of to a different relay.

feature: Add support for external identities in kind 0 events (NIP-39)

We should support adding external identities in kind 0 events. Read more about NIP-39 here.

feature: NIP-58 (Badges) support

I haven't read too much up on badges but it seems pretty easy to implement. We should have one command for creating a badge and one for issuing the badge to a npub.

feat: Mine public keys

Add support for mining public keys. Tools such as Rana and Nostril already has this feature but it would be nice to have it here as well.

feature: NIP-30 support (resources)

I want to implement experimental support for NIP-30 in case some devs want to play around with such events. I'm explicitly saying "experimental support" as the NIP-30 pr is still a "draft" and is subject to change.