Skip to content

Commit 7c5430f

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 a2bc54c commit 7c5430f

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

0 commit comments

Comments
 (0)