Command Line Interface (CLI)

The hdwallet CLI provides a simple way to generate wallets, derive addresses, and manage keys directly from your terminal, with options for exporting data in JSON and CSV formats.

hdwallet

Usage

hdwallet [OPTIONS] COMMAND [ARGS]...

Options

-v, --version

Show HDWallet version and exit

dump

Select Dump hdwallet keys

Usage

hdwallet dump [OPTIONS]

Options

-sym, --symbol <symbol>

Set Cryptocurrency ticker symbol

Default:

'BTC'

-h, --hd <hd>

Select HD

Default:

'BIP44'

-n, --network <network>

Select Network type

Default:

'mainnet'

-ec, --entropy-client <entropy_client>

Select Entropy client

Default:

'BIP39'

-e, --entropy <entropy>

Set Master key from Entropy hex string

-mc, --mnemonic-client <mnemonic_client>

Select Mnemonic client

Default:

'BIP39'

-m, --mnemonic <mnemonic>

Set Master key from Mnemonic words

-l, --language <language>

Select Language for mnemonic

Default:

'english'

-sc, --seed-client <seed_client>

Select Seed client

Default:

'BIP39'

-s, --seed <seed>

Set Master key from Seed hex string

-pp, --passphrase <passphrase>

Set Passphrase for mnemonic & seed

-xprv, --xprivate-key <xprivate_key>

Set Master key from XPrivate key

-xpub, --xpublic-key <xpublic_key>

Set Master key from XPublic key

-enc, --encoded <encoded>

Set Encoded for XPrivate & XPublic keys

Default:

True

-st, --strict <strict>

Set Strict for Root XPrivate & XPublic keys

Default:

False

-pkt, --public-key-type <public_key_type>

Select Public key type

Default:

'compressed'

-d, --derivation <derivation>

Select Derivation name

Default:

'BIP44'

-ac, --account <account>

Set Account index for derivation

Default:

'0'

-ch, --change <change>

Set Change index for derivation

Default:

'0'

-ecc, --ecc <ecc>

Set ECC index for HDW derivation

Default:

'0'

-ro, --role <role>

Set Role index for CIP1852 derivation

Default:

'0'

-ad, --address <address>

Set Address index for derivation

Default:

'0'

-mi, --minor <minor>

Set Minor index for Monero derivation

Default:

'1'

-ma, --major <major>

Set Major index for Monero derivation

Default:

'0'

-p, --path <path>

Set Path for derivation

-i, --indexes <indexes>

Set Indexes for derivation

Default:

-prv, --private-key <private_key>

Set Private key

-w, --wif <wif>

Set Wallet Import Format (WIF)

-b38, --bip38 <bip38>

Is BIP38 Encrypted Wallet Import Format

Default:

False

-pub, --public-key <public_key>

Set Public key

-sprv, --spend-private-key <spend_private_key>

Set Spend Private key for Monero

-vprv, --view-private-key <view_private_key>

Set View Private key for Monero

-spub, --spend-public-key <spend_public_key>

Set Spend Public key for Monero

-stpub, --staking-public-key <staking_public_key>

Set Staking Public key for Cardano Shelley

-ct, --cardano-type <cardano_type>

Select Cardano type

Default:

'shelley-icarus'

-at, --address-type <address_type>

Select Address type

-mo, --mode <mode>

Select Mode of Electrum-V2

Default:

'standard'

-mt, --mnemonic-type <mnemonic_type>

Select Mnemonic type of Electrum-V2

Default:

'standard'

-cs, --checksum <checksum>

Set Checksum for Monero

Default:

False

-se, --semantic <semantic>

Set Semantic for BIP141

-pi, --payment-id <payment_id>

Set Payment ID for Monero

-ex, --exclude <exclude>

Set Exclude keys from dumped

Default:

''

dumps

Select Dumps hdwallet keys

Usage

hdwallet dumps [OPTIONS]

Options

-sym, --symbol <symbol>

Set Cryptocurrency ticker symbol

Default:

'BTC'

-h, --hd <hd>

Select HD

Default:

'BIP44'

-n, --network <network>

Select Network type

Default:

'mainnet'

-ec, --entropy-client <entropy_client>

Select Entropy client

Default:

'BIP39'

-e, --entropy <entropy>

Set Master key from Entropy hex string

-mc, --mnemonic-client <mnemonic_client>

Select Mnemonic client

Default:

'BIP39'

-m, --mnemonic <mnemonic>

Set Master key from Mnemonic words

-l, --language <language>

Select Language for mnemonic

Default:

'english'

-sc, --seed-client <seed_client>

Select Seed client

Default:

'BIP39'

-s, --seed <seed>

Set Master key from Seed hex string

-pp, --passphrase <passphrase>

Set Passphrase for mnemonic & seed

-xprv, --xprivate-key <xprivate_key>

Set Master key from XPrivate key

-xpub, --xpublic-key <xpublic_key>

Set Master key from XPublic key

-enc, --encoded <encoded>

Set Encoded for XPrivate & XPublic keys

Default:

True

-st, --strict <strict>

Set Strict for Root XPrivate & XPublic keys

Default:

False

-pkt, --public-key-type <public_key_type>

Select Public key type

Default:

'compressed'

-d, --derivation <derivation>

Select Derivation name

Default:

'BIP44'

-ac, --account <account>

Set Account index for derivation

Default:

'0'

-ch, --change <change>

Set Change index for derivation

Default:

'0'

-ecc, --ecc <ecc>

Set ECC index for HDW derivation

Default:

'0'

-ro, --role <role>

Set Role index for CIP1852 derivation

Default:

'0'

-ad, --address <address>

Set Address index for derivation

Default:

'0'

-mi, --minor <minor>

Set Minor index for Monero derivation

Default:

'1'

-ma, --major <major>

Set Major index for Monero derivation

Default:

'0'

-p, --path <path>

Set Path for derivation

-i, --indexes <indexes>

Set Indexes for derivation

Default:

-prv, --private-key <private_key>

Set Private key

-w, --wif <wif>

Set Wallet Import Format (WIF)

-b38, --bip38 <bip38>

Is BIP38 Encrypted Wallet Import Format

Default:

False

-pub, --public-key <public_key>

Set Public key

-sprv, --spend-private-key <spend_private_key>

Set Spend Private key for Monero

-vprv, --view-private-key <view_private_key>

Set View Private key for Monero

-spub, --spend-public-key <spend_public_key>

Set Spend Public key for Monero

-stpub, --staking-public-key <staking_public_key>

Set Staking Public key for Cardano Shelley

-ct, --cardano-type <cardano_type>

Select Cardano type

Default:

'shelley-icarus'

-at, --address-type <address_type>

Select Address type

-mo, --mode <mode>

Select Mode of Electrum-V2

Default:

'standard'

-mt, --mnemonic-type <mnemonic_type>

Select Mnemonic type of Electrum-V2

Default:

'standard'

-cs, --checksum <checksum>

Set Checksum for Monero

Default:

False

-se, --semantic <semantic>

Set Semantic for BIP141

-pi, --payment-id <payment_id>

Set Payment ID for Monero

-ex, --exclude <exclude>

Set Exclude keys from dumped

Default:

''

-f, --format <format>

Show dumps format type

Default:

'csv'

-in, --include <include>

Set Include keys from dumped

-inh, --include-header

Set Include header from dumped

Default:

False

-de, --delimiter <delimiter>

Set Delimiter for CSV

Default:

' '

generate

Select Generate for HDWallet

Usage

hdwallet generate [OPTIONS] COMMAND [ARGS]...

entropy

Select Entropy for generation entropy

Usage

hdwallet generate entropy [OPTIONS]

Options

-c, --client <client>

Set Entropy client

Default:

'BIP39'

-s, --strength <strength>

Set Strength for entropy

mnemonic

Select Mnemonic for generation mnemonic

Usage

hdwallet generate mnemonic [OPTIONS]

Options

-c, --client <client>

Set Mnemonic client

Default:

'BIP39'

-l, --language <language>

Set Mnemonic language

-e, --entropy <entropy>

Set Mnemonic entropy

-w, --words <words>

Set Mnemonic words

-mt, --mnemonic-type <mnemonic_type>

Set Mnemonic type for Electrum-V2

Default:

'standard'

-max, --max-attempts <max_attempts>

Set Max attempts for Electrum-V2

Default:

1000000000000000000000000000000000000000000000000000000000000

-cs, --checksum <checksum>

Set Checksum for Monero

Default:

False

seed

Select Seed for generation seed

Usage

hdwallet generate seed [OPTIONS]

Options

-c, --client <client>

Set Seed client

Default:

'BIP39'

-m, --mnemonic <mnemonic>

Set Seed mnemonic

-p, --passphrase <passphrase>

Set Seed passphrase

-ct, --cardano-type <cardano_type>

Set Cardano Seed type

Default:

'byron-icarus'

-mt, --mnemonic-type <mnemonic_type>

Set Mnemonic type for Electrum-V2

Default:

'standard'

list

Select List for HDWallet information

Usage

hdwallet list [OPTIONS] COMMAND [ARGS]...

cryptocurrencies

List Available cryptocurrencies of HDWallet

Usage

hdwallet list cryptocurrencies [OPTIONS]

languages

List Languages of mnemonic words

Usage

hdwallet list languages [OPTIONS]

strengths

List Strengths of mnemonic words

Usage

hdwallet list strengths [OPTIONS]