Skip to content

Commit 62dc143

Browse files
committed
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.
1 parent e284c75 commit 62dc143

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,31 @@ listening at [wss://relay.damus.io wss://nos.lol wss://relay.nsecbunker.com]:
174174
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
175175
```
176176
177-
You can also display a QR code for the bunker URI by adding the `--qrcode` flag:
177+
#### Bunker subcommands
178+
179+
Bunker has a few subcommands that you can use to manage it, type `help` to see them all:
180+
```shell
181+
~> ./nak bunker relay.nsec.app
182+
wss://relay.nsec.app... ok.
183+
listening at [wss://relay.nsec.app]:
184+
pubkey: f59911b561c37c90b01e9e5c2557307380835c83399756f4d62d8167227e420a
185+
npub: npub17kv3rdtpcd7fpvq7newz24eswwqgxhyr8xt4daxk9kqkwgn7gg9q4gy8vf
186+
to restart: nak bunker relay.nsec.app
187+
bunker: bunker://f59911b561c37c90b01e9e5c2557307380835c83399756f4d62d8167227e420a?relay=wss%3A%2F%2Frelay.nsec.app&secret=cAMoUOddVMla
188+
189+
--------------- Bunker Command Interface ---------------
190+
Type 'help' for available commands or 'exit' to quit.
191+
--------------------------------------------------------
192+
help
193+
Available Commands:
194+
help, h, ? - Show this help message
195+
info, i - Display current bunker information
196+
qr - Generate and display QR code for the bunker URI
197+
connect, c <nostrconnect://uri> - Connect to a remote client using nostrconnect:// URI
198+
exit, quit, q - Shutdown the bunker
199+
```
200+
201+
You can also display qr code automatically using the `--qrcode` flag:
178202
179203
```shell
180204
~> nak bunker --qrcode --sec ncryptsec1... relay.damus.io

0 commit comments

Comments
 (0)