1
0
mirror of https://github.com/trezor/trezor-firmware.git synced 2024-12-17 11:58:13 +00:00

docs: update OPTIONS.rst

This commit is contained in:
Pavol Rusnak 2018-12-24 13:27:55 +01:00
parent e9b7ecd97f
commit a9f39b94a5
No known key found for this signature in database
GPG Key ID: 91F3B339B9A02A3D

View File

@ -9,64 +9,75 @@ Use the following command to see all options:
trezorctl --help trezorctl --help
.. code:: .. code::
Usage: trezorctl [OPTIONS] COMMAND [ARGS]... Usage: trezorctl [OPTIONS] COMMAND [ARGS]...
Options: Options:
-t, --transport [usb|udp|pipe|bridge] -p, --path TEXT Select device by specific path.
Select transport used for communication. -v, --verbose Show communication messages.
-p, --path TEXT Select device by transport-specific path. -j, --json Print result as JSON object
-v, --verbose Show communication messages. --help Show this message and exit.
-j, --json Print result as JSON object
--help Show this message and exit.
Commands: Commands:
backup-device Perform device seed backup. backup-device Perform device seed backup.
change-pin Change new PIN or remove existing. cardano-get-address Get Cardano address.
clear-session Clear session (remove cached PIN, passphrase,... cardano-get-public-key Get Cardano public key.
cosi-commit Ask device to commit to CoSi signing. cardano-sign-tx Sign Cardano transaction.
cosi-sign Ask device to sign using CoSi. change-pin Change new PIN or remove existing.
decrypt-keyvalue Decrypt value by given key and path. clear-session Clear session (remove cached PIN,...
decrypt-message Decrypt message. cosi-commit Ask device to commit to CoSi signing.
disable-passphrase Disable passphrase. cosi-sign Ask device to sign using CoSi.
enable-passphrase Enable passphrase. decrypt-keyvalue Decrypt value by given key and path.
encrypt-keyvalue Encrypt value by given key and path. disable-passphrase Disable passphrase.
encrypt-message Encrypt message. enable-passphrase Enable passphrase.
ethereum-get-address Get Ethereum address in hex encoding. encrypt-keyvalue Encrypt value by given key and path.
ethereum-sign-message Sign message with Ethereum address. ethereum-get-address Get Ethereum address in hex encoding.
ethereum-sign-tx Sign (and optionally publish) Ethereum... ethereum-sign-message Sign message with Ethereum address.
ethereum-verify-message Verify message signed with Ethereum address. ethereum-sign-tx Sign (and optionally publish)...
firmware-update Upload new firmware to device (must be in... ethereum-verify-message Verify message signed with Ethereum...
get-address Get address for specified path. firmware-update Upload new firmware to device.
get-entropy Get example entropy. get-address Get address for specified path.
get-features Retrieve device features and settings. get-entropy Get example entropy.
get-public-node Get public node of given path. get-features Retrieve device features and...
lisk-get-address Get Lisk address for specified path. get-public-node Get public node of given path.
lisk-get-public-key Get Lisk public key for specified path. lisk-get-address Get Lisk address for specified path.
lisk-sign-message Sign message with Lisk address. lisk-get-public-key Get Lisk public key for specified...
lisk-sign-tx Sign Lisk transaction. lisk-sign-message Sign message with Lisk address.
lisk-verify-message Verify message signed with Lisk address. lisk-sign-tx Sign Lisk transaction.
list List connected TREZOR devices. lisk-verify-message Verify message signed with Lisk...
load-device Load custom configuration to the device. list List connected TREZOR devices.
nem-get-address Get NEM address for specified path. load-device Load custom configuration to the...
nem-sign-tx Sign (and optionally broadcast) NEM transaction. monero-get-address Get Monero address for specified...
ping Send ping message. monero-get-watch-key Get Monero watch key for specified...
recovery-device Start safe recovery workflow. nem-get-address Get NEM address for specified path.
reset-device Perform device setup and generate new seed. nem-sign-tx Sign (and optionally broadcast) NEM...
self-test Perform a self-test. ontology-get-address Get Ontology address for specified...
set-auto-lock-delay Set auto-lock delay (in seconds). ontology-get-public-key Get Ontology public key for specified...
set-flags Set device flags. ontology-sign-ont-id-add-attributes
set-homescreen Set new homescreen. Sign Ontology ONT ID Attributes...
set-label Set new device label. ontology-sign-ont-id-register Sign Ontology ONT ID Registration.
set-passphrase-source Set passphrase source. ontology-sign-transfer Sign Ontology transfer.
set-u2f-counter Set U2F counter. ontology-sign-withdraw-ong Sign Ontology withdraw Ong.
sign-message Sign message using address of given path. ping Send ping message.
sign-tx Sign transaction. recovery-device Start safe recovery workflow.
stellar-get-address Get Stellar public address reset-device Perform device setup and generate new...
stellar-get-public-key Get Stellar public key ripple-get-address Get Ripple address
stellar-sign-transaction Sign a base64-encoded transaction envelope ripple-sign-tx Sign Ripple transaction
verify-message Verify message. self-test Perform a self-test.
version Show version of trezorctl/trezorlib. set-auto-lock-delay Set auto-lock delay (in seconds).
wipe-device Reset device to factory defaults and remove all... set-flags Set device flags.
set-homescreen Set new homescreen.
set-label Set new device label.
set-passphrase-source Set passphrase source.
set-u2f-counter Set U2F counter.
sign-message Sign message using address of given...
sign-tx Sign transaction.
stellar-get-address Get Stellar public address
stellar-sign-transaction Sign a base64-encoded transaction...
tezos-get-address Get Tezos address for specified path.
tezos-get-public-key Get Tezos public key.
tezos-sign-tx Sign Tezos transaction.
verify-message Verify message.
version Show version of trezorctl/trezorlib.
wipe-device Reset device to factory defaults and...