Skip to content

cmd, ethkey: Fixing the README of ethkey, to match the updated commands #17332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fjl merged 2 commits into from
Sep 4, 2018
Merged

cmd, ethkey: Fixing the README of ethkey, to match the updated commands #17332

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3589ceb
cmd, ethkey: Fixing the README of ethkey, to match the updated commands
epappas Aug 7, 2018
0778f09
cmd, ethkey: Amend the new flags in the README, to match the ethkey u…
epappas Aug 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions cmd/ethkey/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,33 @@ 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>`
### `ethkey signmessage <keyfile> <message/file>`

Sign the message with a keyfile.
It is possible to refer to a file containing the message.
To sign a message contained in a file, use the `--msgfile` flag.


### `ethkey verify <address> <signature> <message/file>`
### `ethkey verifymessage <address> <signature> <message/file>`

Verify the signature of the message.
It is possible to refer to a file containing the message.
To sign a message contained in a file, use the --msgfile flag.


### `ethkey changepassphrase <keyfile>`

Change the passphrase of a keyfile.
use the `--newpasswordfile` to point to the new password file.


## 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
to pass the passphrase by using the `--passwordfile` flag pointing to a file that
contains the passphrase.

## JSON

In case you need to output the result in a JSON format, you shall by using the `--json` flag.