github.com/isti4github/eth-ecc@v0.0.0-20201227085832-c337f2d99319/cmd/ethkey/README.md (about)

     1  ethkey
     2  ======
     3  
     4  ethkey is a simple command-line tool for working with Ethereum keyfiles.
     5  
     6  
     7  # Usage
     8  
     9  ### `ethkey generate`
    10  
    11  Generate a new keyfile.
    12  If you want to use an existing private key to use in the keyfile, it can be 
    13  specified by setting `--privatekey` with the location of the file containing the 
    14  private key.
    15  
    16  
    17  ### `ethkey inspect <keyfile>`
    18  
    19  Print various information about the keyfile.
    20  Private key information can be printed by using the `--private` flag;
    21  make sure to use this feature with great caution!
    22  
    23  
    24  ### `ethkey signmessage <keyfile> <message/file>`
    25  
    26  Sign the message with a keyfile.
    27  It is possible to refer to a file containing the message.
    28  To sign a message contained in a file, use the `--msgfile` flag.
    29  
    30  
    31  ### `ethkey verifymessage <address> <signature> <message/file>`
    32  
    33  Verify the signature of the message.
    34  It is possible to refer to a file containing the message.
    35  To sign a message contained in a file, use the --msgfile flag.
    36  
    37  
    38  ### `ethkey changepassword <keyfile>`
    39  
    40  Change the password of a keyfile.
    41  use the `--newpasswordfile` to point to the new password file.
    42  
    43  
    44  ## Passwords
    45  
    46  For every command that uses a keyfile, you will be prompted to provide the 
    47  password for decrypting the keyfile.  To avoid this message, it is possible
    48  to pass the password by using the `--passwordfile` flag pointing to a file that
    49  contains the password.
    50  
    51  ## JSON
    52  
    53  In case you need to output the result in a JSON format, you shall by using the `--json` flag.