Skip to content

Commit

Permalink
copy key documentation to keyring command
Browse files Browse the repository at this point in the history
  • Loading branch information
nasdf committed Jun 27, 2024
1 parent 1aaf57e commit 364af24
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion cli/keyring.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}

0 comments on commit 364af24

Please sign in to comment.