diff options
Diffstat (limited to 'cmd/ethkey/README.md')
-rw-r--r-- | cmd/ethkey/README.md | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/cmd/ethkey/README.md b/cmd/ethkey/README.md new file mode 100644 index 000000000..cf72ba43d --- /dev/null +++ b/cmd/ethkey/README.md @@ -0,0 +1,41 @@ +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! + + +### `ethkey sign <keyfile> <message/file>` + +Sign the message with a keyfile. +It is possible to refer to a file containing the message. + + +### `ethkey verify <address> <signature> <message/file>` + +Verify the signature of the message. +It is possible to refer to a file containing the message. + + +## Passphrases + +For every command that uses a keyfile, you will be prompted to provide the +passphrase for decrypting the keyfile. To avoid this message, it is possible +to pass the passphrase by using the `--passphrase` flag pointing to a file that +contains the passphrase. |