From f78663909c6faa38d8a0307df8688880832b1ea9 Mon Sep 17 00:00:00 2001 From: Anthony Accioly <1591739+aaccioly@users.noreply.github.com> Date: Fri, 4 Jul 2025 19:05:43 +0100 Subject: [PATCH] docs(readme): add bunker subcommands documentation - Document new bunker subcommands, including `help`, `info`, `qr`, and `connect`. - Update examples for displaying bunker QR codes and usage instructions. --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7cade1f..75da72a 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,31 @@ listening at [wss://relay.damus.io wss://nos.lol wss://relay.nsecbunker.com]: bunker: bunker://f59911b561c37c90b01e9e5c2557307380835c83399756f4d62d8167227e420a?relay=wss%3A%2F%2Frelay.damus.io&relay=wss%3A%2F%2Fnos.lol&relay=wss%3A%2F%2Frelay.nsecbunker.com&secret=XuuiMbcLwuwL ``` -you can also display a QR code for the bunker URI by adding the `--qrcode` flag: +#### Bunker subcommands + +Bunker has a few subcommands that you can use to manage it, type `help` to see them all: +```shell +~> ./nak bunker relay.nsec.app +wss://relay.nsec.app... ok. +listening at [wss://relay.nsec.app]: + pubkey: f59911b561c37c90b01e9e5c2557307380835c83399756f4d62d8167227e420a + npub: npub17kv3rdtpcd7fpvq7newz24eswwqgxhyr8xt4daxk9kqkwgn7gg9q4gy8vf + to restart: nak bunker relay.nsec.app + bunker: bunker://f59911b561c37c90b01e9e5c2557307380835c83399756f4d62d8167227e420a?relay=wss%3A%2F%2Frelay.nsec.app&secret=cAMoUOddVMla + +--------------- Bunker Command Interface --------------- +Type 'help' for available commands or 'exit' to quit. +-------------------------------------------------------- +help +Available Commands: + help, h, ? - Show this help message + info, i - Display current bunker information + qr - Generate and display QR code for the bunker URI + connect, c - Connect to a remote client using nostrconnect:// URI + exit, quit, q - Shutdown the bunker +``` + +You can also display a QR code for the bunker URI by adding the `--qrcode` flag: ```shell ~> nak bunker --qrcode --sec ncryptsec1... relay.damus.io