@ledgerhq/live-cli 24.45.1 → 25.0.0-nightly.20260701071638

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +24 -511
  2. package/lib/cli.js +195690 -241629
  3. package/package.json +2 -27
package/README.md CHANGED
@@ -2,7 +2,9 @@
2
2
 
3
3
  > Please be advised this software is experimental and shall not create any obligation for Ledger to continue to develop, offer, support or repair any of its features. The software is provided “as is.” Ledger shall not be liable for any damages whatsoever including loss of profits or data, business interruption arising from using the software.
4
4
 
5
- This package wraps functionality from `@ledgerhq/live-common` into a suite of tools that can be used directly from the terminal
5
+ `@ledgerhq/live-cli` is now **only an e2e/CI tool**. It exists solely as internal plumbing that the monorepo's e2e suites and CI use to drive a few `@ledgerhq/live-common` flows. It is **Speculos-only**: it does not ship USB/HID or HTTP-proxy transports, and it is no longer intended for human/manual use.
6
+
7
+ For real-device, human-facing hardware-wallet flows, use the Ledger Live **desktop** or **mobile** app directly, or [`@ledgerhq/wallet-cli`](../wallet-cli) if a CLI-based interaction is preferred.
6
8
 
7
9
  # Usage
8
10
 
@@ -28,7 +30,6 @@ ledger-live <commands>
28
30
 
29
31
  - Toolchain installed from the repository root with `mise install`
30
32
  - Dependencies installed with `pnpm i`
31
- - On Linux: `sudo apt-get update && sudo apt-get install libudev-dev libusb-1.0-0-dev`
32
33
 
33
34
  The pinned Node and pnpm versions live in the root [`mise.toml`](../../mise.toml).
34
35
  See [repo commands](../../docs/repo-commands.md) for maintained setup,
@@ -53,8 +54,8 @@ pnpm dev:cli
53
54
  ## Run
54
55
 
55
56
  ```bash
56
- # run a command of the cli
57
- pnpm run:cli <command>
57
+ # run a command of the cli (against Speculos)
58
+ SPECULOS_API_PORT=<port> pnpm run:cli <command>
58
59
  ```
59
60
 
60
61
  ## Build
@@ -66,510 +67,22 @@ pnpm build:cli
66
67
 
67
68
  # Documentation
68
69
 
69
- `````
70
- Usage: ledger-live <command> ...
71
-
72
- Usage: ledger-live celoValidatorGroups
73
-
74
- Usage: ledger-live cosmosValidators
75
- --format <String> : json | default
76
-
77
- Usage: ledger-live tezosListBakers
78
- --whitelist : filter whitelist
79
- --format <String> : json | default
80
-
81
- Usage: ledger-live tronSuperRepresentative
82
- --max <Number> : max number of super representatives to return
83
- --format <String> : json | default
84
-
85
- Usage: ledger-live polkadotValidators
86
- --format <String> : json|csv|default
87
- --status <String> : The status of the validators to fetch (all|elected|waiting)
88
- --validator <String> : address of recipient validator that will receive the delegate
89
-
90
- Usage: ledger-live app # Manage Ledger device's apps
91
- -d, --device <String> : provide a specific HID path of a device
92
- -v, --verbose : enable verbose logs
93
- -i, --install <String> : install an application by its name
94
- -u, --uninstall <String> : uninstall an application by its name
95
- -o, --open <String> : open an application by its display name
96
- --debug <String> : get information of an application by its name
97
- -q, --quit : close current application
98
-
99
- Usage: ledger-live appUninstallAll # uninstall all apps in the device
100
- -d, --device <String> : provide a specific HID path of a device
101
-
102
- Usage: ledger-live appsCheckAllAppVersions # install/uninstall all possible apps available on our API to check all is good (even old app versions)
103
- -d, --device <String> : provide a specific HID path of a device
104
- -m, --memo : a file to memorize the previously saved result so we don't run again from the start
105
-
106
- Usage: ledger-live appsInstallAll # test script to install and uninstall all apps
107
- -d, --device <String> : provide a specific HID path of a device
108
-
109
- Usage: ledger-live appsUpdateTestAll # test script to install and uninstall all apps
110
- -d, --device <String> : provide a specific HID path of a device
111
- --index <Number>
112
-
113
- Usage: ledger-live balanceHistory # Get the balance history for accounts
114
- -d, --device <String> : provide a specific HID path of a device
115
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
116
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
117
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
118
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
119
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
120
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
121
- -i, --index <Number> : select the account by index
122
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
123
- --paginateOperations <Number>: if defined, will paginate operations
124
- -p, --period <String> : all | year | month | week | day
125
- -f, --format <default | json | asciichart>: how to display the data
126
-
127
- Usage: ledger-live bot # Run a bot test engine with speculos that automatically create accounts and do transactions
128
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
129
- -m, --mutation <String> : filter the mutation to run by a regexp pattern
130
-
131
- Usage: ledger-live botPortfolio # Use speculos and a list of supported coins to retrieve all accounts
132
- -f, --format <operationBalanceHistoryBackwards | operationBalanceHistory | json | head | default | basic | full | stats | significantTokenTickers>: how to display the data
133
-
134
- Usage: ledger-live botTransfer # transfer funds from one seed (SEED) to another (SEED_RECIPIENT)
135
-
136
- Usage: ledger-live broadcast # Broadcast signed operation(s)
137
- -d, --device <String> : provide a specific HID path of a device
138
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
139
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
140
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
141
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
142
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
143
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
144
- -i, --index <Number> : select the account by index
145
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
146
- --paginateOperations <Number>: if defined, will paginate operations
147
- -t, --signed-operation <String>: JSON file of a signed operation (- for stdin)
148
-
149
- Usage: ledger-live cleanSpeculos # clean all docker instance of speculos
150
-
151
- Usage: ledger-live confirmOp # Quickly verify if an operation id exists with our explorers (by synchronising the parent account)
152
- --id <String> : operation id to search
153
- -f, --format <json | text> : how to display the data
154
-
155
- Usage: ledger-live countervalues # Get the balance history for accounts
156
- -c, --currency <String> : ticker of a currency
157
- -C, --countervalue <String> : ticker of a currency
158
- -p, --period <String> : all | year | month | week | day
159
- -f, --format <stats | supportedFiats | default | json | asciichart>: how to display the data
160
- -v, --verbose
161
- --fiats : enable all fiats as countervalues
162
- -m, --marketcap <Number> : use top N first tickers available in marketcap instead of having to specify each --currency
163
- -g, --disableAutofillGaps : if set, disable the autofill of gaps to evaluate the rates availability
164
- -l, --latest : only fetch latest
165
- -d, --startDate <String>
166
-
167
- Usage: ledger-live derivation
168
-
169
- Usage: ledger-live devDeviceAppsScenario # dev feature to enter into a specific device apps scenario
170
- -d, --device <String> : provide a specific HID path of a device
171
- -s, --scenario <String> : nanos160-outdated-apps | nanos160-outdated-bitcoin-apps
172
-
173
- Usage: ledger-live deviceAppVersion
174
- -d, --device <String> : provide a specific HID path of a device
175
-
176
- Usage: ledger-live deviceInfo
177
- -d, --device <String> : provide a specific HID path of a device
178
-
179
- Usage: ledger-live deviceSDKFirmwareUpdate # Perform a firmware update
180
- -d, --device <String> : provide a specific HID path of a device
181
- --to-my-own-risk : this is a developer feature that allow to flash anything, we are not responsible of your actions, by flashing your device you might reset your seed or block your device
182
- --osuVersion <String> : (to your own risk) provide yourself an OSU version to flash the device with
183
- --listOSUs : list all available OSUs (for all devices, beta and prod versions)
184
-
185
- Usage: ledger-live deviceSDKGetDeviceInfo # Device SDK: get device info
186
- -d, --device <String> : provide a specific HID path of a device
187
-
188
- Usage: ledger-live deviceVersion
189
- -d, --device <String> : provide a specific HID path of a device
190
-
191
- Usage: ledger-live discoverDevices
192
- -m, --module <String> : filter a specific module (either hid | ble)
193
- -i, --interactive : interactive mode that accumulate the events instead of showing them
194
-
195
- Usage: ledger-live envs # Print available environment variables
196
-
197
- Usage: ledger-live estimateMaxSpendable # estimate the max spendable of an account
198
- -d, --device <String> : provide a specific HID path of a device
199
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
200
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
201
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
202
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
203
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
204
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
205
- -i, --index <Number> : select the account by index
206
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
207
- --paginateOperations <Number>: if defined, will paginate operations
208
-
209
- Usage: ledger-live exportAccounts # Export given accounts to Live QR or console for importing
210
- -d, --device <String> : provide a specific HID path of a device
211
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
212
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
213
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
214
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
215
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
216
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
217
- -i, --index <Number> : select the account by index
218
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
219
- --paginateOperations <Number>: if defined, will paginate operations
220
- -o, --out : output to console
221
-
222
- Usage: ledger-live firmwareRepair # Repair a firmware update
223
- -d, --device <String> : provide a specific HID path of a device
224
- --forceMCU <String> : force a mcu version to install
225
-
226
- Usage: ledger-live firmwareUpdate # Perform a firmware update
227
- -d, --device <String> : provide a specific HID path of a device
228
- --to-my-own-risk : this is a developer feature that allow to flash anything, we are not responsible of your actions, by flashing your device you might reset your seed or block your device
229
- --osuVersion <String> : (to your own risk) provide yourself an OSU version to flash the device with
230
- --listOSUs : list all available OSUs (for all devices, beta and prod versions)
231
-
232
- Usage: ledger-live generateTestScanAccounts # Generate a test for scan accounts (live-common dataset)
233
- -d, --device <String> : provide a specific HID path of a device
234
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
235
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
236
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
237
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
238
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
239
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
240
- -i, --index <Number> : select the account by index
241
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
242
- --paginateOperations <Number>: if defined, will paginate operations
243
- -f, --format <operationBalanceHistoryBackwards | operationBalanceHistory | json | head | default | basic | full | stats | significantTokenTickers>: how to display the data
244
-
245
- Usage: ledger-live generateTestTransaction # Generate a test for transaction (live-common dataset)
246
- -d, --device <String> : provide a specific HID path of a device
247
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
248
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
249
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
250
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
251
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
252
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
253
- -i, --index <Number> : select the account by index
254
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
255
- --paginateOperations <Number>: if defined, will paginate operations
256
- --self-transaction : Pre-fill the transaction for the account to send to itself
257
- --use-all-amount : Send MAX of the account balance
258
- --recipient <String> : the address to send funds to
259
- --amount <String> : how much to send in the main currency unit
260
- --shuffle : if using multiple token or recipient, order will be randomized
261
- --collection <String> : collection of an NFT (in corelation with --tokenIds)
262
- --tokenIds <String> : tokenId or list of tokenIds of an NFT separated by commas (order is kept in corelation with --quantities)
263
- --quantities <String> : quantity or list of quantity of an ERC1155 NFT separated by commas (order is kept in corelation with --tokenIds)
264
- --mode <String> : mode of transaction: send, optIn, claimReward
265
- --fees <String> : how much fees
266
- --gasLimit <String> : how much gasLimit. default is estimated with the recipient
267
- --memo <String> : set a memo
268
- -t, --token <String> : use an token account children of the account
269
- --feePerByte <String> : how much fee per byte
270
- -E, --excludeUTXO <String> : exclude utxo by their txhash@index (example: -E hash@3 -E hash@0)
271
- --rbf : enable replace-by-fee
272
- --bitcoin-pick-strategy <String>: utxo picking strategy, one of: DEEP_OUTPUTS_FIRST | OPTIMIZE_SIZE | MERGE_OUTPUTS
273
- --transactionIndex <String>: transaction index of a pending withdraw in case of withdraw mode
274
- --sourceValidator <String>: for redelegate, add a source validator
275
- --cosmosValidator <String>: address of recipient validator that will receive the delegate
276
- --cosmosAmountValidator <String>: Amount that the validator will receive
277
- --tokenId <String> : determine the tokenId of an NFT (related to the --colection)
278
- --gasPrice <String> : how much gasPrice. default is 2gwei. (example format: 2gwei, 0.000001eth, in wei if no unit precised)
279
- --nonce <String> : set a nonce for this transaction
280
- --data <String> : set the transaction data to use for signing the ETH transaction
281
- --fee <String> : how much fee
282
- --tag <Number> : ripple tag
283
- --solanaValidator <String>: validator address to delegate to
284
- --solanaStakeAccount <String>: stake account address to use in the transaction
285
- --memoType <String> : stellar memo type
286
- --memoValue <String> : stellar memo value
287
- --assetIssuer <String> : Asset issuer
288
- --assetCode <String> : Same as token
289
- --storageLimit <String> : how much storageLimit. default is estimated with the recipient
290
- --subAccount <String> : use a sub account instead of the parent by index
291
- --duration <String> : duration in day
292
- --resource <String> : reward ENERGY or BANDWIDTH
293
- --tronVoteName <String>: name of the super representative voting
294
- --tronVoteAddress <String>: address of the super representative voting
295
- --tronVoteCount <String> : number of votes for the vote address
296
- --validator <String> : address of recipient validator that will receive the delegate
297
- --era <String> : Era of when to claim rewards
298
- --rewardDestination <String>: Reward destination
299
-
300
- Usage: ledger-live genuineCheck # Perform a genuine check with Ledger's HSM
301
- -d, --device <String> : provide a specific HID path of a device
302
-
303
- Usage: ledger-live getAddress # Get an address with the device on specific derivations (advanced)
304
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
305
- -d, --device <String> : provide a specific HID path of a device
306
- --path <String> : HDD derivation path
307
- --derivationMode <String>: derivationMode to use
308
- -v, --verify : also ask verification on device
309
-
310
- Usage: ledger-live getBatteryStatus # Get the battery status of the current device
311
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
312
- -d, --device <String> : provide a specific HID path of a device
313
- --p2 <String> : What type of request to run (00-04)
314
-
315
- Usage: ledger-live getDeviceRunningMode # Get the mode (bootloader, main, locked-device, disconnected-or-locked-device) in which the device is
316
- -r, --nbUnresponsiveRetry <Number>: Number of received CantOpenDevice errors while retrying before considering the device as maybe disconnected or cold-started-locked
317
- -t, --unresponsiveTimeoutMs <Number>: Time in ms of the timeout before considering the device unresponsive
318
- -d, --device <String> : provide a specific HID path of a device
319
-
320
- Usage: ledger-live getTransactionStatus # Prepare a transaction and returns 'TransactionStatus' meta information
321
- -d, --device <String> : provide a specific HID path of a device
322
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
323
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
324
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
325
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
326
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
327
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
328
- -i, --index <Number> : select the account by index
329
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
330
- --paginateOperations <Number>: if defined, will paginate operations
331
- --self-transaction : Pre-fill the transaction for the account to send to itself
332
- --use-all-amount : Send MAX of the account balance
333
- --recipient <String> : the address to send funds to
334
- --amount <String> : how much to send in the main currency unit
335
- --shuffle : if using multiple token or recipient, order will be randomized
336
- --collection <String> : collection of an NFT (in corelation with --tokenIds)
337
- --tokenIds <String> : tokenId or list of tokenIds of an NFT separated by commas (order is kept in corelation with --quantities)
338
- --quantities <String> : quantity or list of quantity of an ERC1155 NFT separated by commas (order is kept in corelation with --tokenIds)
339
- --mode <String> : mode of transaction: send, optIn, claimReward
340
- --fees <String> : how much fees
341
- --gasLimit <String> : how much gasLimit. default is estimated with the recipient
342
- --memo <String> : set a memo
343
- -t, --token <String> : use an token account children of the account
344
- --feePerByte <String> : how much fee per byte
345
- -E, --excludeUTXO <String> : exclude utxo by their txhash@index (example: -E hash@3 -E hash@0)
346
- --rbf : enable replace-by-fee
347
- --bitcoin-pick-strategy <String>: utxo picking strategy, one of: DEEP_OUTPUTS_FIRST | OPTIMIZE_SIZE | MERGE_OUTPUTS
348
- --transactionIndex <String>: transaction index of a pending withdraw in case of withdraw mode
349
- --sourceValidator <String>: for redelegate, add a source validator
350
- --cosmosValidator <String>: address of recipient validator that will receive the delegate
351
- --cosmosAmountValidator <String>: Amount that the validator will receive
352
- --tokenId <String> : determine the tokenId of an NFT (related to the --colection)
353
- --gasPrice <String> : how much gasPrice. default is 2gwei. (example format: 2gwei, 0.000001eth, in wei if no unit precised)
354
- --nonce <String> : set a nonce for this transaction
355
- --data <String> : set the transaction data to use for signing the ETH transaction
356
- --fee <String> : how much fee
357
- --tag <Number> : ripple tag
358
- --solanaValidator <String>: validator address to delegate to
359
- --solanaStakeAccount <String>: stake account address to use in the transaction
360
- --memoType <String> : stellar memo type
361
- --memoValue <String> : stellar memo value
362
- --assetIssuer <String> : Asset issuer
363
- --assetCode <String> : Same as token
364
- --storageLimit <String> : how much storageLimit. default is estimated with the recipient
365
- --subAccount <String> : use a sub account instead of the parent by index
366
- --duration <String> : duration in day
367
- --resource <String> : reward ENERGY or BANDWIDTH
368
- --tronVoteAddress <String>: address of the super representative voting
369
- --tronVoteCount <String> : number of votes for the vote address
370
- --validator <String> : address of recipient validator that will receive the delegate
371
- --era <String> : Era of when to claim rewards
372
- --rewardDestination <String>: Reward destination
373
- -f, --format <default | json>: how to display the data
374
-
375
- Usage: ledger-live i18n # Test e2e functionality for device localization support
376
- -d, --device <String> : provide a specific HID path of a device
377
- -i, --install <String> : install a language pack by its id
378
- -u, --uninstall <String> : uninstall a language pack by its id
379
-
380
- Usage: ledger-live listApps # list all installed apps on the device
381
- -d, --device <String> : provide a specific HID path of a device
382
-
383
- Usage: ledger-live ledgerKeyRingProtocol # Ledger Key Ring Protocol command
384
- -d, --device <String> : provide a specific HID path of a device
385
- --initMemberCredentials : Init member credentials for Ledger Key Ring Protocol
386
- --getKeyRingTree : Get or create a Ledger Key Ring Protocol Tree
387
- --encryptUserData : Encrypt user data with the current private key secured by the Ledger Key Ring Protocol
388
- --decryptUserData : Encrypt user data with the current private key secured by the Ledger Key Ring Protocol
389
- --getMembers : Get members of the Ledger Key Ring Protocol Tree
390
- --restoreKeyRingTree : Restore a Ledger Key Ring Protocol Tree
391
- --destroyKeyRingTree : Destroy a Ledger Key Ring Protocol Tree
392
- --pubKey <String> : pubkey for Ledger Key Ring Protocol Tree retrieved from initMemberCredentials result
393
- --privateKey <String> : privatekey for Ledger Key Ring Protocol Tree retrieved from initMemberCredentials result
394
- --rootId <String> : The immutable id of the Tree root retrieved from getKeyRingTree result
395
- --walletSyncEncryptionKey <String>: The secret used to encrypt/decrypt the wallet sync data retrieved from getKeyRingTree result
396
- --applicationPath <String>: privatekey for Ledger Key Ring Protocol Tree from initMemberCredentials result
397
- --message <String> : message to be encrypted/decrypted
398
- --applicationId <Number> : application identifier
399
- --name <String> : name of the instance
400
- --apiBaseUrl <String> : api base url for Ledger Key Ring Protocol
401
-
402
- Usage: ledger-live ledgerSync # Ledger Sync command
403
- --push : Init member credentials for Ledger Key Ring Protocol
404
- --pull : Get or create a Ledger Key Ring Protocol Tree
405
- --pubKey <String> : pubkey for Ledger Key Ring Protocol Tree retrieved from initMemberCredentials result
406
- --privateKey <String> : privatekey for Ledger Key Ring Protocol Tree retrieved from initMemberCredentials result
407
- --rootId <String> : The immutable id of the Tree root retrieved from getKeyRingTree result
408
- --walletSyncEncryptionKey <String>: The secret used to encrypt/decrypt the wallet sync data retrieved from getKeyRingTree result
409
- --applicationPath <String>: privatekey for Ledger Key Ring Protocol Tree from initMemberCredentials result
410
- --data <String> : data to be pushed to Ledger Sync
411
- --version <Number> : version of the data
412
- --applicationId <Number> : application identifier
413
- --name <String> : name of the instance
414
- --apiBaseUrl <String> : api base url for Ledger Key Ring Protocol
415
- --cloudSyncApiBaseUrl <String>: api base url for Cloud Sync
416
-
417
- Usage: ledger-live liveData # utility for Ledger Live app.json file
418
- -d, --device <String> : provide a specific HID path of a device
419
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
420
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
421
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
422
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
423
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
424
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
425
- -i, --index <Number> : select the account by index
426
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
427
- --paginateOperations <Number>: if defined, will paginate operations
428
- --appjson <filename> : path to a live desktop app.json
429
- -a, --add : add accounts to live data
430
-
431
- Usage: ledger-live managerListApps # List apps that can be installed on the device
432
- -d, --device <String> : provide a specific HID path of a device
433
- -f, --format <raw | json | default>
434
-
435
- Usage: ledger-live portfolio # Get a portfolio summary for accounts
436
- -d, --device <String> : provide a specific HID path of a device
437
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
438
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
439
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
440
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
441
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
442
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
443
- -i, --index <Number> : select the account by index
444
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
445
- --paginateOperations <Number>: if defined, will paginate operations
446
- --countervalue <String> : ticker of a currency
447
- -p, --period <String> : all | year | month | week | day
448
- -g, --disableAutofillGaps : if set, disable the autofill of gaps to evaluate the rates availability
449
-
450
- Usage: ledger-live proxy
451
- -d, --device <String> : provide a specific HID path of a device
452
- -f, --file <String> : in combination with --record, will save all the proxied APDUs to a provided file. If --record is not provided, proxy will start in replay mode of the provided file. If --file is not used at all, the proxy will just act as a proxy without saving the APDU.
453
- -v, --verbose : verbose mode
454
- -s, --silent : do not output the proxy logs
455
- --disable-auto-skip : auto skip apdu that don't replay instead of error
456
- -p, --port <String> : specify the http port to use (default: 8435)
457
- -r, --record : see the description of --file
458
-
459
- Usage: ledger-live receive # Receive crypto-assets (verify on device)
460
- -d, --device <String> : provide a specific HID path of a device
461
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
462
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
463
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
464
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
465
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
466
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
467
- -i, --index <Number> : select the account by index
468
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
469
- --paginateOperations <Number>: if defined, will paginate operations
470
- --qr : also display a QR Code
471
-
472
- Usage: ledger-live repl # Low level exchange with the device. Send APDUs from stdin.
473
- -d, --device <String> : provide a specific HID path of a device
474
- -f, --file <filename> : A file can also be provided. By default stdin is used.
475
-
476
- Usage: ledger-live signMessage # Sign a message with the device on specific derivations (advanced)
477
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
478
- --path <String> : HDD derivation path
479
- --message <String> : the message to sign
480
- --rawMessage <String> : raw message to sign (used by walletconnect)
481
- --parser <String> : parser used for the message. Default: String
482
-
483
- Usage: ledger-live speculosList # list apps available for speculos
484
-
485
- Usage: ledger-live staxFetchAndRestoreDemo # Conditionally backup, delete, and restore a custom image on Stax
486
- -d, --device <String> : provide a specific HID path of a device
487
- -i, --fileInput <String> : Text file containing the hex data of the image to load on Stax
488
-
489
- Usage: ledger-live customLockScreenFetch # Test functionality lock screen customization on Stax for fetching an image
490
- -d, --device <String> : provide a specific HID path of a device
491
- -o, --fileOutput <String> : Output file path in case you want to save Hex string image
492
-
493
- Usage: ledger-live customLockScreenFetchHash # Fetch the hash of the custom image
494
- -d, --device <String> : provide a specific HID path of a device
495
-
496
- Usage: ledger-live customLockScreenLoad # Test functionality lock screen customization on Stax for loading an image
497
- -d, --device <String> : provide a specific HID path of a device
498
- -i, --fileInput <String> : Text file containing the hex data of the image to load on Stax
499
-
500
- Usage: ledger-live swap # Perform an arbitrary swap between two currencies on the same seed
501
- -m, --mock : Whether or not to use the real backend or a mocked version
502
- -a, --amount <Number> : Amount in satoshi units to send
503
- -u, --useAllAmount : Attempt to send all using the emulated max amount calculation
504
- -t, --tokenId <String> : Use a token account children of the account
505
- -f, --useFloat : Use first floating rate returned. Defaults to false.
506
- -d, --device <String> : provide a specific HID path of a device
507
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
508
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
509
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
510
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
511
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
512
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
513
- -i, --index <Number> : select the account by index
514
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
515
- --paginateOperations <Number>: if defined, will paginate operations
516
-
517
- Usage: ledger-live sync # Synchronize accounts with blockchain
518
- -d, --device <String> : provide a specific HID path of a device
519
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
520
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
521
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
522
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
523
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
524
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
525
- -i, --index <Number> : select the account by index
526
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
527
- --paginateOperations <Number>: if defined, will paginate operations
528
- -f, --format <operationBalanceHistoryBackwards | operationBalanceHistory | json | head | default | basic | full | stats | significantTokenTickers>: how to display the data
529
-
530
- Usage: ledger-live synchronousOnboarding # track the onboarding status of your device
531
- -p, --pollingPeriodMs <Number>: polling period in milliseconds
532
- -d, --device <String> : provide a specific HID path of a device
533
-
534
- Usage: ledger-live testDetectOpCollision # Detect operation collisions
535
- -d, --device <String> : provide a specific HID path of a device
536
- --xpub <String> : use an xpub (alternatively to --device) [DEPRECATED: prefer use of id]
537
- --id <String> : restore an account id (or a partial version of an id) (alternatively to --device)
538
- --file <filename> : use a JSON account file or '-' for stdin (alternatively to --device)
539
- --appjsonFile <filename> : use a desktop app.json (alternatively to --device)
540
- -c, --currency <String> : Currency name or ticker. If not provided, it will be inferred from the device.
541
- -s, --scheme <String> : if provided, filter the derivation path that are scanned by a given sceme. Providing '' empty string will only use the default standard derivation scheme.
542
- -i, --index <Number> : select the account by index
543
- -l, --length <Number> : set the number of accounts after the index. Defaults to 1 if index was provided, Infinity otherwise.
544
- --paginateOperations <Number>: if defined, will paginate operations
545
-
546
- Usage: ledger-live testGetTrustedInputFromTxHash
547
- -d, --device <String> : provide a specific HID path of a device
548
- -c, --currency <String>
549
- -h, --hash <String>
550
-
551
- Usage: ledger-live user
552
-
553
- Usage: ledger-live version
554
-
555
-
556
-
557
- ````
558
- `.--:::::
559
- `.-::::::::: ````
560
- .://///:-..`` `-/+++/-`
561
- `://///-` -++++++o/.
562
- `/+++/:` -+++++osss+`
563
- `:++++:` ./++++-/osss/`
564
- .+++++` `-://- .ooooo.
565
- -+ooo/` `` `/oooo-
566
- .oooo+` .::-.` `+++++.
567
- `+oooo:./+++/. -++++/`
568
- -ossso+++++:` -/+++/.
569
- -ooo+++++:` .://///.
570
- ./+++++/` ``.-://///:`
571
- `---.` -:::::///:-.
572
- :::::::-.`
573
- ....``
574
-
575
- `````
70
+ The CLI exposes a small, fixed set of commands consumed by e2e and CI, plus the
71
+ per-family commands contributed by coin modules (e.g. `cosmosValidators`,
72
+ `polkadotValidators`). Run `ledger-live --help` for the up-to-date list and options.
73
+
74
+ | Command | Used by |
75
+ | --- | --- |
76
+ | `getAddress` | e2e — reads an on-device address / public key |
77
+ | `liveData` | e2e — generates/adds accounts into the app dataset |
78
+ | `send` | e2e — token-approval / send flow |
79
+ | `tokenAllowance` | e2e — reads an ERC-20 allowance |
80
+ | `generateAddresses` | e2e (`generate-e2e-userdata.yml`) — generates the address cache for account-based coins |
81
+ | `generateUtxoAddresses` | e2e (`generate-e2e-userdata.yml`) — generates the address cache for UTXO-based coins |
82
+ | `generateAppJson` | e2e (`generate-e2e-userdata.yml`) — generates the app dataset (userdata) for the desktop/mobile e2e suites |
83
+ | `botTransfer` | CI (`bot-transfer.yml`) transfers funds between Speculos seeds |
84
+ | `version` | the package's own smoke test |
85
+
86
+ All of these run against a Speculos device (`SPECULOS_API_PORT` or `SPECULOS_APDU_PORT`).
87
+ Passing a non-Speculos device id fails with an explicit error pointing to the desktop/mobile
88
+ app or `@ledgerhq/wallet-cli`.