move cli to apps/ from live-common (LedgerHQ#61)

* move cli to apps/ from live-common * add documentation on CLI, closes LedgerHQ#177 * add changeset
NicolasFlamel1 · Jun 6, 2022 · 77aa0a5 · 77aa0a5
1 parent 71091b5
commit 77aa0a5
Show file tree

Hide file tree

Showing 79 changed files with 164 additions and 239 deletions.
diff --git a/.changeset/early-bikes-press.md b/.changeset/early-bikes-press.md
@@ -0,0 +1,5 @@
+---
+"@ledgerhq/live-cli": major
+---
+
+extracted live-cli to it's own module
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -19,6 +19,9 @@ tools:
 automation:
   - .github/**/*
 
+cli:
+  - apps/cli/**/*
+
 translations:
   - apps/ledger-live-desktop/static/i18n/**/*
   - apps/ledger-live-mobile/src/locales/**/*

diff --git a/libs/ledger-live-common/cli/.gitignore → apps/cli/.gitignore b/libs/ledger-live-common/cli/.gitignore → apps/cli/.gitignore
diff --git a/libs/ledger-live-common/cli/CHANGELOG.md → apps/cli/CHANGELOG.md b/libs/ledger-live-common/cli/CHANGELOG.md → apps/cli/CHANGELOG.md
diff --git a/libs/ledger-live-common/cli/README.md → apps/cli/README.md b/libs/ledger-live-common/cli/README.md → apps/cli/README.md
@@ -1,10 +1,68 @@
-## ledger-live CLI tools
+# ledger-live CLI
 
 > 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.
 
+This package wraps functionality from `@ledgerhq/live-common` into a suite of tools that can be used directly from the terminal
+
+# Usage
+
+## Install the CLI
+
+```bash
+npm i --global @ledgerhq/live-cli
+```
+
+## Run commands
+
+Jump to the [documentation](#Documentation) for more informations on the available commands
+
+```bash
+ledger-live <commands>
 ```
-Ledger Live @ https://github.com/LedgerHQ/ledger-live-common
 
+# Development
+
+## Setup
+
+### Requirements
+
+- [NodeJS](https://nodejs.org) `lts/fermium` (v14.x)
+- [PnPm](https://pnpm.io) (v7.x)
+- [Python](https://www.python.org/) (v3.5+)
+- On Linux: `sudo apt-get update && sudo apt-get install libudev-dev libusb-1.0-0-dev`
+
+## Install
+
+> Reminder: all commands should be run at the root of the monorepository
+
+```bash
+# install dependencies
+pnpm i
+```
+
+## Dev
+```bash
+# launch a watch mode on the source files and recompiles on the fly
+pnpm dev:cli 
+```
+
+## Run
+
+```bash
+# run a command of the cli
+pnpm run:cli <command>
+```
+
+## Build
+
+```bash
+# build the cli for publishing
+pnpm build:cli
+```
+
+# Documentation
+
+```
 Usage: ledger-live <command> ...
 
 Usage: ledger-live cosmosValidators

diff --git a/libs/ledger-live-common/cli/bin/index.js → apps/cli/bin/index.js b/libs/ledger-live-common/cli/bin/index.js → apps/cli/bin/index.js
diff --git a/libs/ledger-live-common/cli/package.json → apps/cli/package.json b/libs/ledger-live-common/cli/package.json → apps/cli/package.json
@@ -30,6 +30,7 @@
     "@ledgerhq/cryptoassets": "workspace:^",
     "@ledgerhq/errors": "workspace:^",
     "@ledgerhq/hw-app-btc": "workspace:^",
+    "@ledgerhq/hw-transport": "workspace:^",
     "@ledgerhq/hw-transport-http": "workspace:^",
     "@ledgerhq/hw-transport-mocker": "workspace:^",
     "@ledgerhq/hw-transport-node-hid": "workspace:^",
@@ -44,6 +45,7 @@
     "command-line-args": "^5.2.1",
     "cors": "^2.8.5",
     "express": "^4.17.2",
+    "invariant": "^2.2.4",
     "lodash": "^4.17.21",
     "lodash.product": "^18.9.19",
     "qrcode-terminal": "^0.12.0",
@@ -52,7 +54,8 @@
     "react-dom": "^17.0.2",
     "react-redux": "^7.2.6",
     "rxjs": "^6.6.7",
-    "winston": "^3.5.1"
+    "winston": "^3.5.1",
+    "ws": "^8.6.0"
   },
   "devDependencies": {
     "@types/command-line-args": "^5.2.0",
@@ -61,4 +64,4 @@
     "ts-node": "^10.4.0",
     "typescript": "^4.5.5"
   }
-}
+}
diff --git a/libs/ledger-live-common/cli/scripts/gen.sh → apps/cli/scripts/gen.sh b/libs/ledger-live-common/cli/scripts/gen.sh → apps/cli/scripts/gen.sh
diff --git a/libs/ledger-live-common/cli/src/cli.ts → apps/cli/src/cli.ts b/libs/ledger-live-common/cli/src/cli.ts → apps/cli/src/cli.ts
diff --git a/...ger-live-common/cli/src/commands-index.ts → apps/cli/src/commands-index.ts b/...ger-live-common/cli/src/commands-index.ts → apps/cli/src/commands-index.ts
diff --git a/...edger-live-common/cli/src/commands/app.ts → apps/cli/src/commands/app.ts b/...edger-live-common/cli/src/commands/app.ts → apps/cli/src/commands/app.ts
diff --git a/...ommon/cli/src/commands/appUninstallAll.ts → apps/cli/src/commands/appUninstallAll.ts b/...ommon/cli/src/commands/appUninstallAll.ts → apps/cli/src/commands/appUninstallAll.ts
diff --git a/...i/src/commands/appsCheckAllAppVersions.ts → ...i/src/commands/appsCheckAllAppVersions.ts b/...i/src/commands/appsCheckAllAppVersions.ts → ...i/src/commands/appsCheckAllAppVersions.ts
diff --git a/...common/cli/src/commands/appsInstallAll.ts → apps/cli/src/commands/appsInstallAll.ts b/...common/cli/src/commands/appsInstallAll.ts → apps/cli/src/commands/appsInstallAll.ts
diff --git a/...mon/cli/src/commands/appsUpdateTestAll.ts → apps/cli/src/commands/appsUpdateTestAll.ts b/...mon/cli/src/commands/appsUpdateTestAll.ts → apps/cli/src/commands/appsUpdateTestAll.ts
diff --git a/...common/cli/src/commands/balanceHistory.ts → apps/cli/src/commands/balanceHistory.ts b/...common/cli/src/commands/balanceHistory.ts → apps/cli/src/commands/balanceHistory.ts
diff --git a/...edger-live-common/cli/src/commands/bot.ts → apps/cli/src/commands/bot.ts b/...edger-live-common/cli/src/commands/bot.ts → apps/cli/src/commands/bot.ts
diff --git a/...e-common/cli/src/commands/botPortfolio.ts → apps/cli/src/commands/botPortfolio.ts b/...e-common/cli/src/commands/botPortfolio.ts → apps/cli/src/commands/botPortfolio.ts
diff --git a/...ve-common/cli/src/commands/botTransfer.ts → apps/cli/src/commands/botTransfer.ts b/...ve-common/cli/src/commands/botTransfer.ts → apps/cli/src/commands/botTransfer.ts
diff --git a/...live-common/cli/src/commands/broadcast.ts → apps/cli/src/commands/broadcast.ts b/...live-common/cli/src/commands/broadcast.ts → apps/cli/src/commands/broadcast.ts
diff --git a/...-common/cli/src/commands/cleanSpeculos.ts → apps/cli/src/commands/cleanSpeculos.ts b/...-common/cli/src/commands/cleanSpeculos.ts → apps/cli/src/commands/cleanSpeculos.ts
diff --git a/...-common/cli/src/commands/countervalues.ts → apps/cli/src/commands/countervalues.ts b/...-common/cli/src/commands/countervalues.ts → apps/cli/src/commands/countervalues.ts
diff --git a/...ive-common/cli/src/commands/derivation.ts → apps/cli/src/commands/derivation.ts b/...ive-common/cli/src/commands/derivation.ts → apps/cli/src/commands/derivation.ts
diff --git a/...cli/src/commands/devDeviceAppsScenario.ts → ...cli/src/commands/devDeviceAppsScenario.ts b/...cli/src/commands/devDeviceAppsScenario.ts → ...cli/src/commands/devDeviceAppsScenario.ts
diff --git a/...mmon/cli/src/commands/deviceAppVersion.ts → apps/cli/src/commands/deviceAppVersion.ts b/...mmon/cli/src/commands/deviceAppVersion.ts → apps/cli/src/commands/deviceAppVersion.ts
diff --git a/...ive-common/cli/src/commands/deviceInfo.ts → apps/cli/src/commands/deviceInfo.ts b/...ive-common/cli/src/commands/deviceInfo.ts → apps/cli/src/commands/deviceInfo.ts
diff --git a/...-common/cli/src/commands/deviceVersion.ts → apps/cli/src/commands/deviceVersion.ts b/...-common/cli/src/commands/deviceVersion.ts → apps/cli/src/commands/deviceVersion.ts
diff --git a/...ommon/cli/src/commands/discoverDevices.ts → apps/cli/src/commands/discoverDevices.ts b/...ommon/cli/src/commands/discoverDevices.ts → apps/cli/src/commands/discoverDevices.ts
diff --git a/...dger-live-common/cli/src/commands/envs.ts → apps/cli/src/commands/envs.ts b/...dger-live-common/cli/src/commands/envs.ts → apps/cli/src/commands/envs.ts
diff --git a/.../cli/src/commands/estimateMaxSpendable.ts → .../cli/src/commands/estimateMaxSpendable.ts b/.../cli/src/commands/estimateMaxSpendable.ts → .../cli/src/commands/estimateMaxSpendable.ts
diff --git a/...common/cli/src/commands/exportAccounts.ts → apps/cli/src/commands/exportAccounts.ts b/...common/cli/src/commands/exportAccounts.ts → apps/cli/src/commands/exportAccounts.ts
diff --git a/...common/cli/src/commands/firmwareRepair.ts → apps/cli/src/commands/firmwareRepair.ts b/...common/cli/src/commands/firmwareRepair.ts → apps/cli/src/commands/firmwareRepair.ts
diff --git a/...common/cli/src/commands/firmwareUpdate.ts → apps/cli/src/commands/firmwareUpdate.ts b/...common/cli/src/commands/firmwareUpdate.ts → apps/cli/src/commands/firmwareUpdate.ts
diff --git a/...rc/commands/generateAppJsonFromDataset.ts → ...rc/commands/generateAppJsonFromDataset.ts b/...rc/commands/generateAppJsonFromDataset.ts → ...rc/commands/generateAppJsonFromDataset.ts
diff --git a/.../src/commands/generateTestScanAccounts.ts → .../src/commands/generateTestScanAccounts.ts b/.../src/commands/generateTestScanAccounts.ts → .../src/commands/generateTestScanAccounts.ts
diff --git a/...i/src/commands/generateTestTransaction.ts → ...i/src/commands/generateTestTransaction.ts b/...i/src/commands/generateTestTransaction.ts → ...i/src/commands/generateTestTransaction.ts
diff --git a/...e-common/cli/src/commands/genuineCheck.ts → apps/cli/src/commands/genuineCheck.ts b/...e-common/cli/src/commands/genuineCheck.ts → apps/cli/src/commands/genuineCheck.ts
diff --git a/...ive-common/cli/src/commands/getAddress.ts → apps/cli/src/commands/getAddress.ts b/...ive-common/cli/src/commands/getAddress.ts → apps/cli/src/commands/getAddress.ts
diff --git a/.../cli/src/commands/getTransactionStatus.ts → .../cli/src/commands/getTransactionStatus.ts b/.../cli/src/commands/getTransactionStatus.ts → .../cli/src/commands/getTransactionStatus.ts
diff --git a/...-live-common/cli/src/commands/liveData.ts → apps/cli/src/commands/liveData.ts b/...-live-common/cli/src/commands/liveData.ts → apps/cli/src/commands/liveData.ts
diff --git a/...n/cli/src/commands/makeCompoundSummary.ts → apps/cli/src/commands/makeCompoundSummary.ts b/...n/cli/src/commands/makeCompoundSummary.ts → apps/cli/src/commands/makeCompoundSummary.ts
diff --git a/...ommon/cli/src/commands/managerListApps.ts → apps/cli/src/commands/managerListApps.ts b/...ommon/cli/src/commands/managerListApps.ts → apps/cli/src/commands/managerListApps.ts
diff --git a/...live-common/cli/src/commands/portfolio.ts → apps/cli/src/commands/portfolio.ts b/...live-common/cli/src/commands/portfolio.ts → apps/cli/src/commands/portfolio.ts
diff --git a/...ger-live-common/cli/src/commands/proxy.ts → apps/cli/src/commands/proxy.ts b/...ger-live-common/cli/src/commands/proxy.ts → apps/cli/src/commands/proxy.ts
diff --git a/...r-live-common/cli/src/commands/receive.ts → apps/cli/src/commands/receive.ts b/...r-live-common/cli/src/commands/receive.ts → apps/cli/src/commands/receive.ts
diff --git a/...dger-live-common/cli/src/commands/repl.ts → apps/cli/src/commands/repl.ts b/...dger-live-common/cli/src/commands/repl.ts → apps/cli/src/commands/repl.ts
diff --git a/...-live-common/cli/src/commands/satstack.ts → apps/cli/src/commands/satstack.ts b/...-live-common/cli/src/commands/satstack.ts → apps/cli/src/commands/satstack.ts
diff --git a/...common/cli/src/commands/satstackStatus.ts → apps/cli/src/commands/satstackStatus.ts b/...common/cli/src/commands/satstackStatus.ts → apps/cli/src/commands/satstackStatus.ts
diff --git a/...ommon/cli/src/commands/scanDescriptors.ts → apps/cli/src/commands/scanDescriptors.ts b/...ommon/cli/src/commands/scanDescriptors.ts → apps/cli/src/commands/scanDescriptors.ts
diff --git a/...dger-live-common/cli/src/commands/send.ts → apps/cli/src/commands/send.ts b/...dger-live-common/cli/src/commands/send.ts → apps/cli/src/commands/send.ts
diff --git a/...ve-common/cli/src/commands/signMessage.ts → apps/cli/src/commands/signMessage.ts b/...ve-common/cli/src/commands/signMessage.ts → apps/cli/src/commands/signMessage.ts
diff --git a/...e-common/cli/src/commands/speculosList.ts → apps/cli/src/commands/speculosList.ts b/...e-common/cli/src/commands/speculosList.ts → apps/cli/src/commands/speculosList.ts
diff --git a/...dger-live-common/cli/src/commands/swap.ts → apps/cli/src/commands/swap.ts b/...dger-live-common/cli/src/commands/swap.ts → apps/cli/src/commands/swap.ts
diff --git a/...dger-live-common/cli/src/commands/sync.ts → apps/cli/src/commands/sync.ts b/...dger-live-common/cli/src/commands/sync.ts → apps/cli/src/commands/sync.ts
diff --git a/...cli/src/commands/testDetectOpCollision.ts → ...cli/src/commands/testDetectOpCollision.ts b/...cli/src/commands/testDetectOpCollision.ts → ...cli/src/commands/testDetectOpCollision.ts
diff --git a/...commands/testGetTrustedInputFromTxHash.ts → ...commands/testGetTrustedInputFromTxHash.ts b/...commands/testGetTrustedInputFromTxHash.ts → ...commands/testGetTrustedInputFromTxHash.ts
diff --git a/...dger-live-common/cli/src/commands/user.ts → apps/cli/src/commands/user.ts b/...dger-live-common/cli/src/commands/user.ts → apps/cli/src/commands/user.ts
diff --git a/...r-live-common/cli/src/commands/version.ts → apps/cli/src/commands/version.ts b/...r-live-common/cli/src/commands/version.ts → apps/cli/src/commands/version.ts
diff --git a/...-common/cli/src/commands/walletconnect.ts → apps/cli/src/commands/walletconnect.ts b/...-common/cli/src/commands/walletconnect.ts → apps/cli/src/commands/walletconnect.ts
diff --git a/...-common/cli/src/live-common-setup-base.ts → apps/cli/src/live-common-setup-base.ts b/...-common/cli/src/live-common-setup-base.ts → apps/cli/src/live-common-setup-base.ts
diff --git a/...-live-common/cli/src/live-common-setup.ts → apps/cli/src/live-common-setup.ts b/...-live-common/cli/src/live-common-setup.ts → apps/cli/src/live-common-setup.ts
diff --git a/libs/ledger-live-common/cli/src/qr.ts → apps/cli/src/qr.ts b/libs/ledger-live-common/cli/src/qr.ts → apps/cli/src/qr.ts
diff --git a/libs/ledger-live-common/cli/src/scan.ts → apps/cli/src/scan.ts b/libs/ledger-live-common/cli/src/scan.ts → apps/cli/src/scan.ts
diff --git a/...er-live-common/cli/src/signedOperation.ts → apps/cli/src/signedOperation.ts b/...er-live-common/cli/src/signedOperation.ts → apps/cli/src/signedOperation.ts
diff --git a/libs/ledger-live-common/cli/src/stream.ts → apps/cli/src/stream.ts b/libs/ledger-live-common/cli/src/stream.ts → apps/cli/src/stream.ts
diff --git a/...ledger-live-common/cli/src/transaction.ts → apps/cli/src/transaction.ts b/...ledger-live-common/cli/src/transaction.ts → apps/cli/src/transaction.ts
diff --git a/.../ledger-live-common/cli/src/tsconfig.json → apps/cli/src/tsconfig.json b/.../ledger-live-common/cli/src/tsconfig.json → apps/cli/src/tsconfig.json
diff --git a/...ive-common/cli/tests/encryption/mandatory → apps/cli/tests/encryption/mandatory b/...ive-common/cli/tests/encryption/mandatory → apps/cli/tests/encryption/mandatory
diff --git a/...e-common/cli/tests/libcoreReset/mandatory → apps/cli/tests/libcoreReset/mandatory b/...e-common/cli/tests/libcoreReset/mandatory → apps/cli/tests/libcoreReset/mandatory
diff --git a/...r-live-common/cli/tests/version/mandatory → apps/cli/tests/version/mandatory b/...r-live-common/cli/tests/version/mandatory → apps/cli/tests/version/mandatory
diff --git a/libs/ledger-live-common/cli/tsconfig.json → apps/cli/tsconfig.json b/libs/ledger-live-common/cli/tsconfig.json → apps/cli/tsconfig.json
diff --git a/libs/ledger-live-common/.circleci.disabled/config.yml b/libs/ledger-live-common/.circleci.disabled/config.yml
diff --git a/libs/ledger-live-common/cli/tests/encryption/apdu.snapshot.log b/libs/ledger-live-common/cli/tests/encryption/apdu.snapshot.log
diff --git a/libs/ledger-live-common/cli/tests/libcoreReset/apdu.snapshot.log b/libs/ledger-live-common/cli/tests/libcoreReset/apdu.snapshot.log
diff --git a/libs/ledger-live-common/cli/tests/version/apdu.snapshot.log b/libs/ledger-live-common/cli/tests/version/apdu.snapshot.log
diff --git a/libs/ledger-live-common/package.json b/libs/ledger-live-common/package.json
@@ -24,7 +24,6 @@
     "test": "pnpm ci-test-common",
     "ci-lint": "pnpm lint",
     "ci-test-common": "env-cmd -f ./.ci.env pnpm jest --ci --updateSnapshot && git diff --exit-code src",
-    "ci-test-cli": "cd cli && pnpm test",
     "ci-test-bot": "env-cmd -f ./.ci.env pnpm jest --testMatch '**/*.bot.ts'"
   },
   "files": [

diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "license": "MIT",
   "private": true,
-  "packageManager": "pnpm@7.0.0",
+  "packageManager": "pnpm@7.1.0",
   "scripts": {
     "clean": "git clean -fdX",
     "changelog": "changeset add",
@@ -24,15 +24,15 @@
     "clean:ljs": "pnpm turbo run clean --filter='./libs/ledgerjs/**'",
     "doc:ljs": "pnpm turbo run doc --filter='./libs/ledgerjs/**'",
     "watch:ljs": "pnpm turbo run watch --filter='./libs/ledgerjs/**'",
-    "dev:cli": "pnpm turbo run start --filter=live-cli",
+    "dev:cli": "pnpm turbo run watch --filter=live-cli",
     "dev:lld": "pnpm turbo run start --filter=ledger-live-desktop",
     "dev:llm": "pnpm turbo run start --filter=live-mobile",
     "release:lld": "pnpm turbo run release --filter=ledger-live-desktop",
     "pre:lld": "pnpm turbo run pre-build --filter=ledger-live-desktop",
     "nightly": "pnpm turbo run nightly --include-dependencies --no-deps",
     "nightly:lld": "pnpm turbo run nightly --filter=ledger-live-desktop",
     "test": "pnpm turbo run test --concurrency=100%",
-    "run:cli": "./libs/ledger-live-common/cli/bin/index.js",
+    "run:cli": "./apps/cli/bin/index.js",
     "lint": "pnpm turbo run lint",
     "lint:fix": "pnpm turbo run lint:fix",
     "typecheck": "pnpm turbo run typecheck",