Skip to content

Commit

Permalink
Update CLI documentation from the cli output (#571)
Browse files Browse the repository at this point in the history
  • Loading branch information
gre authored Jul 5, 2022
1 parent 5f5d3cd commit 88d1f1b
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions apps/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,6 @@ Usage: ledger-live firmwareUpdate # Perform a firmware update
--osuVersion <String> : (to your own risk) provide yourself an OSU version to flash the device with
--listOSUs : list all available OSUs (for all devices, beta and prod versions)
Usage: ledger-live generateAppJsonFromDataset # Extract accounts from test datasets and print a sample app.json usable for tests
Usage: ledger-live generateTestScanAccounts # Generate a test for scan accounts (live-common dataset)
-d, --device <String> : provide a specific HID path of a device
--xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
Expand Down Expand Up @@ -266,6 +264,8 @@ Usage: ledger-live generateTestTransaction # Generate a test for transaction (li
--rewardDestination <String>: Reward destination
--fee <String> : how much fee
--tag <Number> : ripple tag
--solanaValidator <String>: validator address to delegate to
--solanaStakeAccount <String>: stake account address to use in the transaction
--memoType <String> : stellar memo type
--memoValue <String> : stellar memo value
--storageLimit <String> : how much storageLimit. default is estimated with the recipient
Expand Down Expand Up @@ -326,6 +326,8 @@ Usage: ledger-live getTransactionStatus # Prepare a transaction and returns 'Tra
--rewardDestination <String>: Reward destination
--fee <String> : how much fee
--tag <Number> : ripple tag
--solanaValidator <String>: validator address to delegate to
--solanaStakeAccount <String>: stake account address to use in the transaction
--memoType <String> : stellar memo type
--memoValue <String> : stellar memo value
--storageLimit <String> : how much storageLimit. default is estimated with the recipient
Expand Down Expand Up @@ -467,6 +469,8 @@ Usage: ledger-live send # Send crypto-assets
--rewardDestination <String>: Reward destination
--fee <String> : how much fee
--tag <Number> : ripple tag
--solanaValidator <String>: validator address to delegate to
--solanaStakeAccount <String>: stake account address to use in the transaction
--memoType <String> : stellar memo type
--memoValue <String> : stellar memo value
--storageLimit <String> : how much storageLimit. default is estimated with the recipient
Expand All @@ -482,8 +486,9 @@ Usage: ledger-live send # Send crypto-assets
Usage: ledger-live signMessage # Sign a message with the device on specific derivations (advanced)
-c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
--path <String> : HDD derivation path
--derivationMode <String>: derivationMode to use
--message <String> : the message to sign
--rawMessage <String> : raw message to sign (used by walletconnect)
--parser <String> : parser used for the message. Default: String
Usage: ledger-live speculosList # list apps available for speculos
Expand Down Expand Up @@ -518,6 +523,10 @@ Usage: ledger-live sync # Synchronize accounts with blockchain
--paginateOperations <Number>: if defined, will paginate operations
-f, --format <operationBalanceHistoryBackwards | operationBalanceHistory | json | head | default | basic | full | stats | significantTokenTickers>: how to display the data
Usage: ledger-live synchronousOnboarding # track the onboarding status of your device
-p, --pollingPeriodMs <Number>: polling period in milliseconds
-d, --device <String> : provide a specific HID path of a device
Usage: ledger-live testDetectOpCollision # Detect operation collisions
-d, --device <String> : provide a specific HID path of a device
--xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
Expand Down Expand Up @@ -574,5 +583,4 @@ Usage: ledger-live walletconnect # Create a walletconnect session
:::::::-.`
....``


```

0 comments on commit 88d1f1b

Please sign in to comment.