Skip to content

Commit a426225

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 7055f9b commit a426225

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

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

0 commit comments

Comments
 (0)