naddr

naddr

---

Documentation

---

NAddr Encoder CLI

A powerful and easy-to-use command-line interface (CLI) for encoding NAddr (Nostr Address) format. This tool simplifies the process of generating NAddr strings, making it perfect for developers working with Nostr-related applications.

🌟 Features

• Encode NAddr strings with a simple command
• Support for all required NAddr components
• Optional relay URL inclusion
• User-friendly command-line interface
• Built with Node.js for cross-platform compatibility

🚀 Installation

You can install the NAddr Encoder CLI globally using npm:

npm install -g naddr

📖 Usage

After installation, you can use the naddr command from anywhere in your terminal.

Basic Usage

naddr -d <identifier> -p <pubkey> -k <kind> [-r <relay>]

Options

• -d, --identifier <string>: The identifier for the NAddr (required)
• -p, --pubkey <hex>: The author's public key in hexadecimal format (required)
• -k, --kind <number>: The kind number (required)
• -r, --relay <url>: The relay URL (optional)
• -h, --help: Display help information
• -V, --version: Output the version number

Example

naddr -d myprofile -p 3bf0c63fcb93463407af97a5e5ee64fa883d107ef9e558472c4eb9aaaefa459d -k 1234 -r wss://example.com

This command will output the encoded NAddr string.

🛠️ Development

To set up the project for development:

1. Clone the repository:

   git clone https://github.com/nostrapps/naddr.git
   cd naddr

2. Install dependencies:

   npm install

3. Link the package locally:

   npm link

Now you can run the naddr command, and it will use your local development version.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

📄 License

This project is MIT licensed.

🙏 Acknowledgements

• Nostr Protocol for the NAddr specification
• bech32 for Bech32 encoding
• commander for the CLI interface

Made with ❤️ by Melvin Carvalho