2019-11-15 12:26:24 +00:00
|
|
|
Command-line options for trezorctl
|
|
|
|
|
==================================
|
2017-12-06 15:32:05 +00:00
|
|
|
|
|
|
|
|
See `EXAMPLES.rst <EXAMPLES.rst>`_ for examples on how to use.
|
|
|
|
|
|
2019-11-15 12:26:24 +00:00
|
|
|
``trezorctl`` is split into a number of subcommands based on currency and/or
|
|
|
|
|
functionality. The best way to get up-to-date help is to use the integrated help option.
|
|
|
|
|
|
|
|
|
|
The full list of subcommands can be seen like so:
|
2017-12-06 15:32:05 +00:00
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl --help
|
|
|
|
|
|
2019-11-15 12:26:24 +00:00
|
|
|
Each subcommand has its own help, shown with ``trezorctl <command> --help``.
|
|
|
|
|
|
|
|
|
|
List of subcommands
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
For convenience of search, the help texts of all commands and subcommands are listed
|
|
|
|
|
on one page here.
|
|
|
|
|
|
|
|
|
|
.. ### ALL CONTENT BELOW IS GENERATED BY helper-scripts/make-options-rst.py ###
|
2017-12-06 15:32:05 +00:00
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl [OPTIONS] COMMAND [ARGS]...
|
2018-12-27 23:18:04 +00:00
|
|
|
|
2017-12-06 15:32:05 +00:00
|
|
|
Options:
|
2020-03-04 12:45:19 +00:00
|
|
|
-p, --path TEXT Select device by specific path.
|
|
|
|
|
-v, --verbose Show communication messages.
|
|
|
|
|
-j, --json Print result as JSON object
|
|
|
|
|
-P, --passphrase-on-host Enter passphrase on host.
|
|
|
|
|
-s, --session-id HEX Resume given session ID.
|
|
|
|
|
--version Show the version and exit.
|
|
|
|
|
--help Show this message and exit.
|
2018-12-27 23:18:04 +00:00
|
|
|
|
2017-12-06 15:32:05 +00:00
|
|
|
Commands:
|
2020-03-04 12:45:19 +00:00
|
|
|
binance Binance Chain commands.
|
|
|
|
|
btc Bitcoin and Bitcoin-like coins commands.
|
|
|
|
|
cardano Cardano commands.
|
|
|
|
|
clear-session Clear session (remove cached PIN, passphrase, etc.).
|
|
|
|
|
cosi CoSi (Cothority / collective signing) commands.
|
|
|
|
|
crypto Miscellaneous cryptography features.
|
|
|
|
|
debug Miscellaneous debug features.
|
|
|
|
|
device Device management commands - setup, recover seed, wipe, etc.
|
|
|
|
|
eos EOS commands.
|
|
|
|
|
ethereum Ethereum commands.
|
|
|
|
|
fido FIDO2, U2F and WebAuthN management commands.
|
2021-05-19 11:18:54 +00:00
|
|
|
firmware Firmware commands.
|
2020-03-04 12:45:19 +00:00
|
|
|
get-features Retrieve device features and settings.
|
|
|
|
|
get-session Get a session ID for subsequent commands.
|
|
|
|
|
list List connected Trezor devices.
|
|
|
|
|
monero Monero commands.
|
|
|
|
|
nem NEM commands.
|
|
|
|
|
ping Send ping message.
|
|
|
|
|
ripple Ripple commands.
|
|
|
|
|
set Device settings.
|
|
|
|
|
stellar Stellar commands.
|
|
|
|
|
tezos Tezos commands.
|
|
|
|
|
usb-reset Perform USB reset on stuck devices.
|
|
|
|
|
version Show version of trezorctl/trezorlib.
|
|
|
|
|
wait-for-emulator Wait until Trezor Emulator comes up.
|
2019-11-15 12:26:24 +00:00
|
|
|
|
|
|
|
|
Binance Chain commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl binance --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl binance [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Binance Chain commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-address Get Binance address for specified path.
|
|
|
|
|
get-public-key Get Binance public key.
|
2020-08-05 10:03:06 +00:00
|
|
|
sign-tx Sign Binance transaction.
|
2019-11-15 12:26:24 +00:00
|
|
|
|
|
|
|
|
Bitcoin and Bitcoin-like coins commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl btc --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl btc [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Bitcoin and Bitcoin-like coins commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-address Get address for specified path.
|
2021-05-19 11:18:54 +00:00
|
|
|
get-descriptor Get descriptor of given account.
|
2019-11-15 12:26:24 +00:00
|
|
|
get-public-node Get public node of given path.
|
|
|
|
|
sign-message Sign message using address of given path.
|
|
|
|
|
sign-tx Sign transaction.
|
|
|
|
|
verify-message Verify message.
|
|
|
|
|
|
|
|
|
|
Cardano commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl cardano --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl cardano [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Cardano commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-address Get Cardano address.
|
|
|
|
|
get-public-key Get Cardano public key.
|
|
|
|
|
sign-tx Sign Cardano transaction.
|
|
|
|
|
|
|
|
|
|
CoSi (Cothority / collective signing) commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl cosi --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl cosi [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
CoSi (Cothority / collective signing) commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
commit Ask device to commit to CoSi signing.
|
|
|
|
|
sign Ask device to sign using CoSi.
|
|
|
|
|
|
|
|
|
|
Miscellaneous cryptography features.
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl crypto --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl crypto [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Miscellaneous cryptography features.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
decrypt-keyvalue Decrypt value by given key and path.
|
|
|
|
|
encrypt-keyvalue Encrypt value by given key and path.
|
|
|
|
|
get-entropy Get random bytes from device.
|
|
|
|
|
|
2020-03-04 12:45:19 +00:00
|
|
|
Miscellaneous debug features.
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl debug --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl debug [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Miscellaneous debug features.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
2020-03-24 15:39:38 +00:00
|
|
|
send-bytes Send raw bytes to Trezor.
|
2020-03-04 12:45:19 +00:00
|
|
|
|
2019-11-15 12:26:24 +00:00
|
|
|
Device management commands - setup, recover seed, wipe, etc.
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl device --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl device [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Device management commands - setup, recover seed, wipe, etc.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
2021-07-28 14:01:02 +00:00
|
|
|
backup Perform device seed backup.
|
|
|
|
|
load Upload seed and custom configuration to the device.
|
|
|
|
|
reboot-to-bootloader Reboot device into bootloader mode.
|
|
|
|
|
recover Start safe recovery workflow.
|
|
|
|
|
sd-protect Secure the device with SD card protection.
|
|
|
|
|
self-test Perform a self-test.
|
|
|
|
|
setup Perform device setup and generate new seed.
|
|
|
|
|
wipe Reset device to factory defaults and remove all private data.
|
2019-11-15 12:26:24 +00:00
|
|
|
|
|
|
|
|
EOS commands.
|
|
|
|
|
~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl eos --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl eos [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
EOS commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-public-key Get Eos public key in base58 encoding.
|
|
|
|
|
sign-transaction Sign EOS transaction.
|
|
|
|
|
|
|
|
|
|
Ethereum commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl ethereum --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl ethereum [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Ethereum commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-address Get Ethereum address in hex encoding.
|
|
|
|
|
get-public-node Get Ethereum public node of given path.
|
|
|
|
|
sign-message Sign message with Ethereum address.
|
feat(core/ethereum): EIP-712
Based on original contribution by Max Kupriianov <xlab@hey.com>
Implemented EIP-712 typed data signatures in Ethereum app.
Add eth_abi into pyproject deps
device test for EIP 712
fixed hex decoding for address
fixup! fixed hex decoding for address
code quality, more pythonic code, removing unused imports
running black and isort on changed files
trezorctl file input for EIP 712 data signing
fixup! code quality, more pythonic code, removing unused imports
fixup! fixup! code quality, more pythonic code, removing unused imports
necessary changes after rebase to master
unit tests for sign_typed_data.py
new protobuf messages, working for nonarray types
simplified and verified solution for our simple data
support for simple arrays, without their confirmation
reverting protobuf value messages to bytes, appropriate changes
showing arrays in Trezor, code quality improvements
data validation on Trezor, minor improvements
using custom types for storing type data instead of dicts, addressing feedback from review
moving helper functions to its own file, tests for decode_data
additional overall tests
support for arrays of structs
adding support for metamask_v4_compat variable
using HashWriter object to collect the final hash continously
minor improvements in code quality
validate_field_type function
streaming values from client without saving them, missing UI
prototype of streamed UI using confirm_properties
accounting for bytes in data, more data types in integration tests
rebase on master, using f-strings
minor fixes and improvements from code review
StructHasher class for the whole hashing process
mypy and style changes
asking users whether to show structs and arrays
protobuf descriptions to fix make defs_check
unifying comments, mypy fix
unit tests for StructHasher class
UI fixtures, skipping device tests for T1
addressing majority of code review comments about code quality and structure
changing file structure - layouts, helpers, sign_typed_data
decode_data renaming and docstring, renaming unit test file
using tuples instead of lists in elifs
layout improvements
excluding core/src/apps/common/confirm.py file from the PR
True/False returning layout with Show more button
code review layout improvements
forgotten br_type argument to should_show_more
2021-04-12 20:38:07 +00:00
|
|
|
sign-typed-data Sign typed data (EIP-712) with Ethereum address.
|
2019-11-15 12:26:24 +00:00
|
|
|
sign-tx Sign (and optionally publish) Ethereum transaction.
|
|
|
|
|
verify-message Verify message signed with Ethereum address.
|
|
|
|
|
|
|
|
|
|
FIDO2, U2F and WebAuthN management commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl fido --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl fido [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
FIDO2, U2F and WebAuthN management commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
counter Get or set the FIDO/U2F counter value.
|
|
|
|
|
credentials Manage FIDO2 resident credentials.
|
|
|
|
|
|
2021-05-19 11:18:54 +00:00
|
|
|
Firmware commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl firmware --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl firmware [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Firmware commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
download Download and save the firmware image.
|
|
|
|
|
update Upload new firmware to device.
|
|
|
|
|
verify Verify the integrity of the firmware data stored in a file.
|
|
|
|
|
|
2019-11-15 12:26:24 +00:00
|
|
|
Monero commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl monero --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl monero [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Monero commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-address Get Monero address for specified path.
|
|
|
|
|
get-watch-key Get Monero watch key for specified path.
|
|
|
|
|
|
|
|
|
|
NEM commands.
|
|
|
|
|
~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl nem --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl nem [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
NEM commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-address Get NEM address for specified path.
|
|
|
|
|
sign-tx Sign (and optionally broadcast) NEM transaction.
|
|
|
|
|
|
|
|
|
|
Ripple commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl ripple --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl ripple [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Ripple commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-address Get Ripple address
|
|
|
|
|
sign-tx Sign Ripple transaction
|
|
|
|
|
|
|
|
|
|
Device settings.
|
|
|
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl set --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl set [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Device settings.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
2021-05-19 11:18:54 +00:00
|
|
|
auto-lock-delay Set auto-lock delay (in seconds).
|
|
|
|
|
display-rotation Set display rotation.
|
|
|
|
|
experimental-features Enable or disable experimental message types.
|
|
|
|
|
flags Set device flags.
|
|
|
|
|
homescreen Set new homescreen.
|
|
|
|
|
label Set new device label.
|
|
|
|
|
passphrase Enable, disable or configure passphrase protection.
|
|
|
|
|
pin Set, change or remove PIN.
|
|
|
|
|
safety-checks Set safety check level.
|
|
|
|
|
wipe-code Set or remove the wipe code.
|
2019-11-15 12:26:24 +00:00
|
|
|
|
|
|
|
|
Stellar commands.
|
|
|
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl stellar --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl stellar [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Stellar commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-address Get Stellar public address.
|
|
|
|
|
sign-transaction Sign a base64-encoded transaction envelope.
|
|
|
|
|
|
|
|
|
|
Tezos commands.
|
|
|
|
|
~~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
trezorctl tezos --help
|
|
|
|
|
|
|
|
|
|
.. code::
|
|
|
|
|
|
|
|
|
|
Usage: trezorctl tezos [OPTIONS] COMMAND [ARGS]...
|
|
|
|
|
|
|
|
|
|
Tezos commands.
|
|
|
|
|
|
|
|
|
|
Options:
|
|
|
|
|
--help Show this message and exit.
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
get-address Get Tezos address for specified path.
|
|
|
|
|
get-public-key Get Tezos public key.
|
|
|
|
|
sign-tx Sign Tezos transaction.
|
|
|
|
|
|