From dc49124251289e69a856f08596960a2e9262bd33 Mon Sep 17 00:00:00 2001 From: Rootul Patel Date: Fri, 20 Oct 2023 13:32:01 -0400 Subject: [PATCH] docs: add more docs to command --- cmd/celestia-appd/cmd/addrbook.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/cmd/celestia-appd/cmd/addrbook.go b/cmd/celestia-appd/cmd/addrbook.go index a879b197ba..b9b076d1c2 100644 --- a/cmd/celestia-appd/cmd/addrbook.go +++ b/cmd/celestia-appd/cmd/addrbook.go @@ -20,7 +20,10 @@ func addrbookCommand() *cobra.Command { cmd := &cobra.Command{ Use: "addrbook peers.txt addrbook.json", Short: "Convert a list of peers into an address book", - Args: cobra.ExactArgs(2), + Long: "Convert a list of peers into an address book.\n" + + "The first argument (peers.txt) should contain a new line separated list of peers. The format for a peer is `id@ip:port` or `id@domain:port`.\n" + + "The second argument (addrbook.json) should be the output filename. The address book is saved to the output file in JSON format.\n", + Args: cobra.ExactArgs(2), RunE: func(cmd *cobra.Command, args []string) error { inputFile := args[0] outputFile := args[1]