aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/ethkey/README.md
diff options
context:
space:
mode:
authorSteven Roose <stevenroose@gmail.com>2017-12-21 18:36:05 +0800
committerFelix Lange <fjl@users.noreply.github.com>2017-12-21 18:36:05 +0800
commiteeb53bc14301a54aee7cd7e1475e296155ee986d (patch)
treefcda4bda0bfec448817226ec28fc4786edcdaed7 /cmd/ethkey/README.md
parente21aa0fda3b9d0b101d60d03e98a0bdd4d415dea (diff)
downloadgo-tangerine-eeb53bc14301a54aee7cd7e1475e296155ee986d.tar
go-tangerine-eeb53bc14301a54aee7cd7e1475e296155ee986d.tar.gz
go-tangerine-eeb53bc14301a54aee7cd7e1475e296155ee986d.tar.bz2
go-tangerine-eeb53bc14301a54aee7cd7e1475e296155ee986d.tar.lz
go-tangerine-eeb53bc14301a54aee7cd7e1475e296155ee986d.tar.xz
go-tangerine-eeb53bc14301a54aee7cd7e1475e296155ee986d.tar.zst
go-tangerine-eeb53bc14301a54aee7cd7e1475e296155ee986d.zip
cmd/ethkey: new command line tool for keys (#15438)
ethkey is a new tool that serves as a command line interface to the basic key management functionalities of geth. It currently supports: - generating keyfiles - inspecting keyfiles (print public and private key) - signing messages - verifying signed messages
Diffstat (limited to 'cmd/ethkey/README.md')
-rw-r--r--cmd/ethkey/README.md41
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.