keystore: clarify helptext of ipfs key command

ipfs · Mar 21, 2017 · 1ed720c · 1ed720c · GitCop · Mar 21, 2017
1 parent 646dbde
commit 1ed720c
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/core/commands/keystore.go b/core/commands/keystore.go
@@ -19,6 +19,18 @@ import (
 var KeyCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
 		Tagline: "Create and manipulate keypairs",
+		ShortDescription: `
+'ipfs key gen' generates a new keypair for usage with IPNS and 'ipfs name publish'.
+
+  > ipfs key gen --type=rsa --size=2048 mykey
+  > ipfs name publish --key=mykey QmSomeHash
+
+'ipfs key list' lists the available keys.
+
+  > ipfs key list
+  self
+  mykey
+		`,
 	},
 	Subcommands: map[string]*cmds.Command{
 		"gen":  KeyGenCmd,