minkms help
Print help information on a command or concept topic.
MinKMS embeds its complete documentation in the minkms binary, so the reference always matches your installed version.
SYNTAX
minkms help <command>
Running minkms <command> --help prints the same manual page as minkms help <command>.
PARAMETERS
<command>
Required
The command or concept topic to get help for.
Use all for information about all commands and topics.
In addition to the individual commands, help is available for the following concept topics:
| Topic | Description |
|---|---|
hsm |
Hardware security modules and the unseal mechanism. |
tls |
TLS and mutual TLS (mTLS) for the client and cluster surfaces. |
cluster |
Cluster membership, consistency, and fault tolerance. |
keys |
Master keys, key versions, and data keys. |
enclave |
Enclaves as isolated key and identity namespaces. |
iam |
Identities, policies, and access control. |
config |
The server configuration file and options. |
api |
The server HTTP API. |
EXAMPLES
Print the manual page for a command:
minkms help add-key
Print a concept topic:
minkms help hsm
List every command and topic:
minkms help all