From 364af24f2c8c5a1dc46319f9c5e23b770c1508e5 Mon Sep 17 00:00:00 2001
From: Keenan Nemetz <keenan.nemetz@gmail.com>
Date: Thu, 27 Jun 2024 09:19:49 -0700
Subject: [PATCH] copy key documentation to keyring command

---
 cli/keyring.go | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

diff --git a/cli/keyring.go b/cli/keyring.go
index c60440ccc9..a905ce190b 100644
--- a/cli/keyring.go
+++ b/cli/keyring.go
@@ -19,7 +19,21 @@ func MakeKeyringCommand() *cobra.Command {
 		Use:   "keyring",
 		Short: "Manage DefraDB private keys",
 		Long: `Manage DefraDB private keys.
-Generate, import, and export private keys.`,
+Generate, import, and export private keys.
+
+The following keys are loaded from the keyring on start:
+	peer-key: Ed25519 private key (required)
+	encryption-key: AES-128, AES-192, or AES-256 key (optional)
+
+To randomly generate the required keys, run the following command:
+	defradb keyring generate
+
+To import externally generated keys, run the following command:
+	defradb keyring import <name> <private-key-hex>
+
+To learn more about the available options:
+	defradb keyring --help
+`,
 	}
 	return cmd
 }