nethsm(1)                   General Commands Manual                  nethsm(1)

NAME
       nethsm - A CLI for the Nitrokey NetHSM

SYNOPSIS
       nethsm [-a|--auth-passphrase-file] [-c|--config] [-l|--label]
       [-u|--user] [-h|--help] [-V|--version] <subcommands>

DESCRIPTION
       A CLI for the Nitrokey NetHSM

OPTIONS
       -a, --auth-passphrase-file=AUTH_PASSPHRASE_FILE
              The path to a file containing a passphrase for authentication

              The passphrase provided in the file must be the one for the user
              chosen for the command.

              This option can be provided multiple times, which is needed for
              commands that require multiple roles at once.  With multiple
              passphrase files ordering matters, as the files are assigned to
              the respective user provided by the "--user" option.
              May also be specified with the NETHSM_AUTH_PASSPHRASE_FILE
              environment variable.

       -c, --config=CONFIG
              The path to a custom configuration file

              If specified, the custom configuration file is used instead of
              the default configuration file location.
              May also be specified with the NETHSM_CONFIG environment
              variable.

       -l, --label=LABEL
              A label uniquely identifying a device in the configuration file

              Must be provided if more than one device is setup in the
              configuration file.
              May also be specified with the NETHSM_LABEL environment
              variable.

       -u, --user=USER
              A user name which is used for a command

              Can be provided, if no user name is setup in the configuration
              file for a device.  Must be provided, if several user names of
              the same target role are setup in the configuration file for a
              device.

              This option can be provided multiple times, which is needed for
              commands that require multiple roles at once.

              May also be specified with the NETHSM_USER environment variable.

       -h, --help
              Print help (see a summary with '-h')

       -V, --version
              Print version

SUBCOMMANDS
       nethsm-config(1)
              Manage the configuration of a device

       nethsm-env(1)
              Manage environments in the configuration file

       nethsm-health(1)
              Retrieve health information for a device

       nethsm-info(1)
              Retrieve the info for a device

       nethsm-key(1)
              Operate on the keys of a device

       nethsm-lock(1)
              Lock a device

       nethsm-metrics(1)
              Get metrics

       nethsm-namespace(1)
              Operate on namespaces of a device

       nethsm-openpgp(1)
              OpenPGP operations

       nethsm-provision(1)
              Provision a device

       nethsm-random(1)
              Get random bytes from a device

       nethsm-system(1)
              Do system actions for a device

       nethsm-unlock(1)
              Unlock a device

       nethsm-user(1)
              Operate on users of a device

       nethsm-help(1)
              Print this message or the help of the given subcommand(s)

VERSION
       v0.6.0

AUTHORS
       David Runge <dvzrv@archlinux.org>, Wiktor Kwapisiewicz
       <wiktor@archlinux.org>

                                 nethsm 0.6.0                        nethsm(1)