Command Line Interface (CLI)
After you have installed, type hdwallet
to verify that it worked:
$ hdwallet
Usage: hdwallet [OPTIONS] COMMAND [ARGS]...
Options:
-v, --version Show HDWallet version and exit.
-h, --help Show this message and exit.
Commands:
generate (g) Select Generate for HDWallet.
list (l) Select List for HDWallet information.
hdwallet
hdwallet [OPTIONS] COMMAND [ARGS]...
Options
- -v, --version
Show HDWallet version and exit.
generate
Select Generate for HDWallet.
hdwallet generate [OPTIONS] COMMAND [ARGS]...
Options
- -s, --symbol <symbol>
Set Cryptocurrency ticker symbol.
- -sg, --strength <strength>
Set Strength for entropy, choose strength 128, 160, 192, 224 or 256 only.
- Default
128
- -e, --entropy <entropy>
Set Master key from entropy hex string.
- -m, --mnemonic <mnemonic>
Set Master key from mnemonic words.
- -l, --language <language>
Set Language for mnemonic, choose language english, french, italian, spanish, chinese_simplified, chinese_traditional, japanese or korean only.
- Default
english
- -pa, --passphrase <passphrase>
Set Passphrase for mnemonic.
- -sd, --seed <seed>
Set Master key from seed hex string.
- -xprv, --xprivate-key <xprivate_key>
Set Master key from xprivate key.
- -xpub, --xpublic-key <xpublic_key>
Set Master key from xpublic key.
- -st, --strict <strict>
Set Strict for root keys.
- Default
False
- -ac, --account <account>
Set derivation from account.
- Default
0
- -ch, --change <change>
Set Derivation from change.
- Default
False
- -ad, --address <address>
Set Derivation from address.
- Default
0
- -p, --path <path>
Set Master key derivation path.
- -prv, --private-key <private_key>
Set Master key from private key.
- -pub, --public-key <public_key>
Set Master key from public key.
- -w, --wif <wif>
Set Master key from wallet important format.
- -sm, --semantic <semantic>
Set Semantic for xprivate and xpublic keys.
- Default
p2pkh
addresses
Select Addresses for generation HDWallet addresses.
hdwallet generate addresses [OPTIONS]
Options
- -s, --symbol <symbol>
Required Set Cryptocurrency ticker symbol.
- -sg, --strength <strength>
Set Strength for entropy, choose strength 128, 160, 192, 224 or 256 only.
- Default
128
- -e, --entropy <entropy>
Set Master key from entropy hex string.
- -m, --mnemonic <mnemonic>
Set Master key from mnemonic words.
- -l, --language <language>
Set Language for mnemonic, choose language english, french, italian, spanish, chinese_simplified, chinese_traditional, japanese or korean only.
- Default
english
- -pa, --passphrase <passphrase>
Set Passphrase for mnemonic.
- -sd, --seed <seed>
Set Master key from seed hex string.
- -xprv, --xprivate-key <xprivate_key>
Set Master key from xprivate key.
- -xpub, --xpublic-key <xpublic_key>
Set Master key from xpublic key.
- -st, --strict <strict>
Set Strict for root keys.
- Default
False
- -ac, --account <account>
Set derivation from account.
- Default
0
- -ch, --change <change>
Set Derivation from change.
- Default
False
- -p, --path <path>
Set Master key derivation path.
- -se, --semantic <semantic>
Set Semantic for xprivate and xpublic keys.
- Default
p2pkh
- -h, --hardened <hardened>
Set Hardened for addresses.
- Default
False
- -si, --start-index <start_index>
Set Start from address index.
- Default
0
- -ei, --end-index <end_index>
Set End to address index.
- Default
20
- -sh, --show <show>
Set Value key of generated HDWallet data to show.
- Default
path,addresses:p2pkh,public_key,wif
list
Select List for HDWallet information.
hdwallet list [OPTIONS] COMMAND [ARGS]...
cryptocurrencies
List Available cryptocurrencies of HDWallet.
hdwallet list cryptocurrencies [OPTIONS]
languages
List Languages of mnemonic words.
hdwallet list languages [OPTIONS]
strengths
List Strengths of mnemonic words.
hdwallet list strengths [OPTIONS]