Skip to content

wallet-cli

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

wallet-cli

README.md

@metamask/wallet-cli

The CLI of @metamask/wallet

Installation

yarn add @metamask/wallet-cli

or

npm install @metamask/wallet-cli

Usage

The CLI drives a long-lived background daemon that holds an unlocked @metamask/wallet in memory and exposes its messenger over a per-user Unix socket. All commands live under the mm daemon topic; run mm --help (or mm daemon <command> --help) for the full reference.

Start the daemon (flags may also be supplied as the INFURA_PROJECT_ID, MM_WALLET_PASSWORD, and MM_WALLET_SRP environment variables — preferred for secrets):

mm daemon start --infura-project-id <key> --password <pw> --srp "<phrase>"

Discover what the running wallet can do — list prints every messenger action currently dispatchable via call. This surface grows as more controllers are wired, so treat it as evolving rather than a stability contract:

mm daemon list

Call any messenger action on the running wallet (positional JSON array for arguments, optional --timeout):

mm daemon call KeyringController:getState
mm daemon call NetworkController:getState --timeout 10000

For the exact parameters and return shape of a given action, see the TypeDoc/README of the controller that owns it (e.g. @metamask/keyring-controller).

Inspect or tear it down:

mm daemon status          # PID + uptime, or why the socket is unreachable
mm daemon stop            # graceful shutdown (falls back to SIGTERM/SIGKILL)
mm daemon purge           # stop, then delete all daemon state files (--force to skip the prompt)

State (socket, PID file, log, and the SQLite database) lives in the per-user oclif data directory; override it with MM_DATA_DIR.

Troubleshooting

Rebuilding better-sqlite3

This package depends on better-sqlite3, which ships a native C addon. The monorepo runs Yarn with enableScripts: false, so the addon is not fetched automatically during yarn install. Instead, the package's test:prepare script (scripts/install-binaries.sh) downloads the matching prebuild on demand the first time you run tests, falling back to compiling the addon from source (via node-gyp) when no prebuild is published for your Node ABI/platform.

If you switch Node versions or branches and the binding is missing, re-run:

yarn workspace @metamask/wallet-cli run test:prepare

Or invoke prebuild-install directly from the monorepo root (where better-sqlite3 is hoisted):

cd node_modules/better-sqlite3 && node ../.bin/prebuild-install

Testing

Unit tests run with yarn workspace @metamask/wallet-cli test.

The subprocess end-to-end suite (in tests/) spawns the built mm CLI and the native better-sqlite3 addon as real processes, so it is kept out of the unit run and its coverage gate. Build the workspace dependencies first (yarn build from the repo root), then run it with yarn workspace @metamask/wallet-cli test:e2e.

Contributing

This package is part of a monorepo. Instructions for contributing can be found in the monorepo README.