vulpemventures / nigiri

🍣 A delicious docker box for special Bitcoin, Lightning and Liquid cookings
https://nigiri.vulpem.com
MIT License
270 stars 44 forks source link

Improve logs command helper description #75

Closed notmandatory closed 4 years ago

notmandatory commented 4 years ago

The help command shows that [flags] are optional. But if I don't provide a flag I get the below error. I'd expect it to show me the bitcoind logs, or is only liquid logs supported right now?

$ nigiri logs  
Error: Invalid number of args
Usage:
  nigiri logs [flags]

Flags:
  -h, --help     help for logs
      --liquid   Set to see logs of a liquid service

Global Flags:
      --datadir string   Set nigiri default directory (default "/home/steve/.nigiri")
tiero commented 4 years ago

Hello, @notmandatory Thanks for opening this issue, it seems it's not well documented, will improve this in the readme and the CLI helper as well. (the only way to find this would have been the landing page nigiri.vulpem.com )

The correct way to use the logs command is to pass the service name.

$ nigiri logs SERVICE [--liquid]

Bitcoin $ nigiri logs node

Electrs $ nigiri logs electrs

Nigiri Chopsticks $ nigiri logs chopsticks

To use the same services for liquid (eg. elements, electrs-liquid and chopsticks-liquid the flag --liquid need to be given)

notmandatory commented 4 years ago

Thanks, I'm going to change the bitcoindevkit/bdk README to just point to your repo README for detailed usage instructions. Will leave this issue open until you get a chance to update your CLI helper.

tiero commented 4 years ago
$ nigiri logs -h
Check Service logs. Requires one Service: node | esplora | electrs | chopsticks

Usage:
  nigiri logs <service> [flags]

Flags:
  -h, --help     help for logs
      --liquid   Set to see logs of a liquid service

Global Flags:
      --datadir string   Set nigiri default directory (default "/home/tiero/.nigiri")

Let me know if this works for you.

notmandatory commented 4 years ago

yes that looks great, thanks!