2017-12-21 04:36:05 -06:00
|
|
|
ethkey
|
|
|
|
======
|
|
|
|
|
|
|
|
ethkey is a simple command-line tool for working with Ethereum keyfiles.
|
|
|
|
|
|
|
|
|
|
|
|
# Usage
|
|
|
|
|
|
|
|
### `ethkey generate`
|
|
|
|
|
|
|
|
Generate a new keyfile.
|
|
|
|
If you want to use an existing private key to use in the keyfile, it can be
|
|
|
|
specified by setting `--privatekey` with the location of the file containing the
|
|
|
|
private key.
|
|
|
|
|
|
|
|
|
|
|
|
### `ethkey inspect <keyfile>`
|
|
|
|
|
|
|
|
Print various information about the keyfile.
|
|
|
|
Private key information can be printed by using the `--private` flag;
|
|
|
|
make sure to use this feature with great caution!
|
|
|
|
|
|
|
|
|
2018-09-04 06:45:27 -05:00
|
|
|
### `ethkey signmessage <keyfile> <message/file>`
|
2017-12-21 04:36:05 -06:00
|
|
|
|
|
|
|
Sign the message with a keyfile.
|
|
|
|
It is possible to refer to a file containing the message.
|
2018-09-04 06:45:27 -05:00
|
|
|
To sign a message contained in a file, use the `--msgfile` flag.
|
2017-12-21 04:36:05 -06:00
|
|
|
|
|
|
|
|
2018-09-04 06:45:27 -05:00
|
|
|
### `ethkey verifymessage <address> <signature> <message/file>`
|
2017-12-21 04:36:05 -06:00
|
|
|
|
|
|
|
Verify the signature of the message.
|
|
|
|
It is possible to refer to a file containing the message.
|
2018-09-04 06:45:27 -05:00
|
|
|
To sign a message contained in a file, use the --msgfile flag.
|
|
|
|
|
|
|
|
|
2019-08-12 04:00:38 -05:00
|
|
|
### `ethkey changepassword <keyfile>`
|
2018-09-04 06:45:27 -05:00
|
|
|
|
2019-08-12 04:00:38 -05:00
|
|
|
Change the password of a keyfile.
|
2018-09-04 06:45:27 -05:00
|
|
|
use the `--newpasswordfile` to point to the new password file.
|
2017-12-21 04:36:05 -06:00
|
|
|
|
|
|
|
|
2019-08-12 04:00:38 -05:00
|
|
|
## Passwords
|
2017-12-21 04:36:05 -06:00
|
|
|
|
|
|
|
For every command that uses a keyfile, you will be prompted to provide the
|
2019-08-12 04:00:38 -05:00
|
|
|
password for decrypting the keyfile. To avoid this message, it is possible
|
|
|
|
to pass the password by using the `--passwordfile` flag pointing to a file that
|
|
|
|
contains the password.
|
2018-09-04 06:45:27 -05:00
|
|
|
|
|
|
|
## JSON
|
|
|
|
|
|
|
|
In case you need to output the result in a JSON format, you shall by using the `--json` flag.
|