From 8afcae54473a3c0790b340ba7ed5317e1eae04a0 Mon Sep 17 00:00:00 2001 From: ryan Date: Wed, 1 Nov 2023 21:28:55 -0500 Subject: [PATCH] keyfork-user-guide: add more helpful info --- keyfork-user-guide/src/usage.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/keyfork-user-guide/src/usage.md b/keyfork-user-guide/src/usage.md index 3e90e15..205da0e 100644 --- a/keyfork-user-guide/src/usage.md +++ b/keyfork-user-guide/src/usage.md @@ -9,8 +9,8 @@ applications. Once a user has generated a mnemonic with [`keyfork mnemonic generate`], the mnemonic can be loaded to [`keyforkd`]. This is typically done automatically by -[`keyfork`], but plumbing binaries (commands that are not `keyfork`) require -the server to be started manually. +[`keyfork`], but plumbing binaries (commands that are not `keyfork`, such as +`keyfork-derive-key`) require the server to be started manually. **NOTE:** Anything beyond this point should be considered Design by Documentation, and while the commands are not likely to change between now and @@ -18,11 +18,14 @@ when they are released, there is no current stable interface for these commands, and they may change at any time. Users can then "provision" keys, or automatically deploy generated keys to -specific endpoints. For OpenPGP smartcards (such as Yubikeys), `keyfork -provision openpgp-card` will automatically derive an OpenPGP key and provision -it to a smartcard. As previously mentioned, if `keyforkd` was not previously -started, a prompt will be provided by the provisioner for the mnemonic, and -`keyforkd` will be started in the background. +specific endpoints. Running `keyfork provision` will automatically list all +known provisioners, while running `keyfork provision help ` will +include detailed information about the specific provisioner. For OpenPGP +smartcards (such as Yubikeys), `keyfork provision openpgp-card` will +automatically derive an OpenPGP key and provision it to a smartcard. As +previously mentioned, if `keyforkd` was not previously started, a prompt will +be provided by the provisioner for the mnemonic, and `keyforkd` will be started +in the background. Any usage of `keyfork provision` or `keyfork derive` can also be given the `--save` flag, to modify a `keyfork.toml` file and record when the key was @@ -36,3 +39,4 @@ invoked derivation, through an interactive prompt. [BIP-0032]: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki [`keyfork mnemonic generate`]: ./bin/keyfork/mnemonic/index.md#generate [`keyforkd`]: ./bin/keyforkd.md +[`keyfork`]: ./bin/keyfork.md