% SPLINTER-KEYGEN(1) Cargill, Incorporated | Splinter Commands

NAME

splinter-keygen — Generates user and daemon keys for Splinter

SYNOPSIS

splinter keygen [FLAGS] [OPTIONS] [KEY-NAME]

DESCRIPTION

This command generates secp256k1 public/private keys for Splinter.

If no option is specified, this command generates user keys that are stored in the directory $HOME/.splinter/keys. The --system flag generates keys for the Splinter daemon (splinterd) that are stored in /etc/splinter/keys. The --key-dir option generates keys in the specified directory.

The file names are determined by the user name, unless the *KEY-NAME* argument is used.

FLAGS

-f, --force: Overwrites key files if they already exist.
-h, --help: Prints help information
-q, --quiet: Decreases verbosity (the opposite of -v). When specified, only errors or warnings will be output.
--skip: Skip generating the files if they exist. Cannot use --skip with --force.
--system: Generates system keys for splinterd in /etc/splinter/keys.
-V, --version: Prints version information
-v: Increases verbosity (the opposite of -q). Specify multiple times for more output.

OPTIONS

--group GROUP: GROUP that will be assigned group permissions on the generated key files.
--key-dir DIRECTORY: Generates keys in the given DIRECTORY, creating the directory if it does not already exist.

ARGUMENTS

*KEY-NAME*: (Optional) Specifies the base name for the key files. By default, the user name is used.

EXAMPLES

This example generates user keys for a Splinter user who is logged in as paulbunyan.

$ splinter keygen
writing file: "/Users/paulbunyan/.splinter/keys/paulbunyan.priv"
writing file: "/Users/paulbunyan/.splinter/keys/paulbunyan.pub"

This example generates keys for the user babe in the /tmp directory:

$ splinter keygen --key-dir /tmp babe
writing file: "/tmp/babe.priv"
writing file: "/tmp/babe.pub"

The next example generates system keys for the Splinter daemon, but specifies splinterd as the base name for the files (instead of the user name).

$ splinter keygen --system splinterd
writing file: "/etc/splinter/keys/splinterd.priv"
writing file: "/etc/splinter/keys/splinterd.pub"

ENVIRONMENT VARIABLES

SPLINTER_CONFIG_DIR: Specifies the directory containing configuration files, including system keys. (See: --config-dir.)
SPLINTER_HOME: Changes the base directory path for the Splinter directories, including the config directory and system key location. (See the splinterd(1) man page for more information.) This value is not used if SPLINTER_CONFIG_DIR is set.