AIONOSTR(1)

๐Ÿ“ฆ version 0.1.0, in ubuntu resolute, ubuntu stonking

Welcome to the aionostr Manual ๐Ÿ’– bestie, this is your guide to the whole vibe ๐Ÿซถ

๐Ÿฆ‹ NAME ๐Ÿฆ‹

Okay so aionostr is an asyncio Nostr client command-line interface, and it is literally iconic ๐Ÿ’…

โœจ SYNOPSIS โœจ

aionostr [OPTIONS] COMMAND [ARGS]...

๐ŸŒธ DESCRIPTION ๐ŸŒธ

aionostr is a command-line client for the Nostr (Notes and Other Stuff Transmitted by Relays) protocol ๐Ÿ“ก. It's built on asyncio so it can do high-performance asynchronous operations, which is giving speed ๐Ÿ”ฅ

This is a fork of aionostr that does not require Coincurve. It uses electrum-ecc instead, so no Coincurve needed ๐Ÿฆ‹

๐ŸŽ€ OPTIONS ๐ŸŽ€

  • --help โ€” Shows the help message and exits. Lowkey the first thing you should try ๐Ÿ™ˆ

๐Ÿ’œ COMMANDS ๐Ÿ’œ

get NOSTR_ID

Retrieves and displays Nostr objects like nprofile, nevent, and so on โœจ

  • Basic version:
aionostr get nprofile1qqsv0knzz56gtm8mrdjhjtreecl7dl8xa47caafkevfp67svwvhf9hcpz3mhxue69uhkgetnvd5x7mmvd9hxwtn4wvspak3h
  • With -v:
aionostr get -v nevent1qqsxpnzhw2ddf2uplsxgc5ctr9h6t65qaalzvzf0hvljwrz8q64637spp3mhxue69uhkyunz9e5k75j6gxm

query [OPTIONS] FILTER_JSON

Queries Nostr relays with custom filters ๐Ÿงš

aionostr query -s -q '{"kinds": [1], "limit":10}'

send [OPTIONS]

Sends events out to the Nostr network ๐Ÿ’Œ

aionostr send --kind 1 --content "test" --private-key <privatekey>

mirror [OPTIONS] FILTER_JSON

Mirrors events between relays ๐Ÿชž

aionostr mirror -r wss://source.relay -t wss://target.relay --verbose '{"kinds": [4]}'

gen

Generates a brand new Nostr key pair ๐Ÿ”‘ โœจ

๐ŸŒˆ ENVIRONMENT VARIABLES ๐ŸŒˆ

NOSTR_RELAYS

A comma-separated list of default relays to use ๐Ÿ“ฎ

export NOSTR_RELAYS=wss://brb.io,wss://nostr.mom

NOSTR_KEY

The default private key used for signing events ๐Ÿ”

export NOSTR_KEY=$(aionostr gen | head -1)

๐Ÿ’… EXAMPLES ๐Ÿ’…

Basic usage with environment variables

Set up your env vars first, then go wild ๐Ÿ’–

export NOSTR_RELAYS=wss://relay.damus.io
export NOSTR_KEY=$(aionostr gen | head -1)
aionostr send --kind 1 --content "Hello Nostr!"

Query for recent text notes

aionostr query '{"kinds": [1], "limit": 5}'

Mirror direct messages between relays

aionostr mirror -r wss://relay1.com -t wss://relay2.com '{"kinds": [4]}'

๐Ÿ“ FILES ๐Ÿ“

  • /usr/bin/aionostr โ€” The main executable ๐Ÿซง
  • /usr/lib/python3*/dist-packages/electrum_aionostr/ โ€” The Python library files ๐Ÿ

๐Ÿ”— SEE ALSO ๐Ÿ”—

curl(1), python3(1)

The Nostr protocol specification lives at https://github.com/nostr-protocol/nips ๐Ÿ“–

๐Ÿ™ˆ BUGS ๐Ÿ™ˆ

Report bugs to the Debian Bug Tracking System at https://bugs.debian.org/ ๐Ÿ›

Or upstream at https://github.com/spesmilo/electrum-aionostr/issues ๐Ÿž

๐Ÿ‘‘ AUTHOR ๐Ÿ‘‘

The Electrum Developers, who are the fork maintainers ๐Ÿซถ

Original author: Dave St.Germain ๐Ÿ’œ

BSD License ๐Ÿฉต

This is free software: you are free to change and redistribute it ๐ŸŒท


Bye bestie ๐Ÿ’– this page is version 0.0.11, last updated 2025-09-25, and it's all about AIONOSTR(1) ๐Ÿฆ‹ periodt โœจ

๐Ÿ“ฆ where this page comes from