op-geth/cmd/ethkey
willian.eth 52ed3570c4
cmd: migrate to urfave/cli/v2 (#24751)
This change updates our urfave/cli dependency to the v2 branch of the library.
There are some Go API changes in cli v2:

- Flag values can now be accessed using the methods ctx.Bool,
  ctx.Int, ctx.String, ... regardless of whether the flag is 'local' or
  'global'.

- v2 has built-in support for flag categories. Our home-grown category
  system is removed and the categories of flags are assigned as part of
  the flag definition.

For users, there is only one observable difference with cli v2: flags must now
strictly appear before regular arguments. For example, the following command is
now invalid:

   geth account import mykey.json --password file.txt

Instead, the command must be invoked as follows:

   geth account import --password file.txt mykey.json
2022-06-27 18:22:36 +02:00
..
README.md all: replace passPHRASE with passWORD in user interactions (#19932) 2019-08-12 12:00:38 +03:00
changepassword.go cmd: migrate to urfave/cli/v2 (#24751) 2022-06-27 18:22:36 +02:00
generate.go cmd: migrate to urfave/cli/v2 (#24751) 2022-06-27 18:22:36 +02:00
inspect.go cmd: migrate to urfave/cli/v2 (#24751) 2022-06-27 18:22:36 +02:00
main.go cmd: migrate to urfave/cli/v2 (#24751) 2022-06-27 18:22:36 +02:00
message.go cmd: migrate to urfave/cli/v2 (#24751) 2022-06-27 18:22:36 +02:00
message_test.go all: use T.TempDir to create temporary test directories (#24633) 2022-04-08 15:44:55 +02:00
run_test.go all: update license information (#16089) 2018-02-14 13:49:11 +01:00
utils.go cmd: migrate to urfave/cli/v2 (#24751) 2022-06-27 18:22:36 +02:00

README.md

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 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 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 changepassword <keyfile>

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

Passwords

For every command that uses a keyfile, you will be prompted to provide the 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.

JSON

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