public
/
keyfork
5
0
Fork 0
Code Issues 16 Pull Requests 1 Packages Projects Releases Wiki Activity

keyfork-user-guide: add more helpful info

This commit is contained in:
Ryan Heywood 2023-11-01 21:28:55 -05:00
parent 008390d087
commit 8afcae5447
Signed by: ryan
GPG Key ID: 8E401478A3FBEF72
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
keyfork-user-guide/src/usage.md
View File

@ -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 <provisioner>` 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