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:

TopicDescription
hsmHardware security modules and the unseal mechanism.
tlsTLS and mutual TLS (mTLS) for the client and cluster surfaces.
clusterCluster membership, consistency, and fault tolerance.
keysMaster keys, key versions, and data keys.
enclaveEnclaves as isolated key and identity namespaces.
iamIdentities, policies, and access control.
configThe server configuration file and options.
apiThe 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

On this page