Restore Mnemonic CLI

About

Restore Mnemonic CLI allows you to easily find your lost mnemonic by providing you with all valid mnemonics for the combination of words you do know

License

Licensed under the PolyForm Noncommercial License 1.0.0. Commercial use requires a separate written commercial license agreement from the licensor — contact [email protected].

How to run

Option 1: Run via npm (recommended)

This is the recommended way for most users.

Requirements

• Node.js (v22)

Run

npx @extra-wallet/restore-mnemonic

This will:

• download the CLI on demand,
• start the interactive terminal UI

Option 2: Run locally from the repository (development)

Use this if you want to:

• inspect the code,
• modify the CLI,
• contribute or debug.

Requirements

• Node.js (v22)
• pnpm

1. Install dependencies

From the repository root:

pnpm install

2. Build shared code

cd shared/sdk
pnpm build

3. Return to the root of the repository

cd ../..

4. Build the CLI

cd packages/restore-mnemonic-cli
pnpm build

5. Run locally

npx restore-mnemonic

How to use

The CLI can be run in two modes: interactive and non-interactive

To run the program in interactive mode you just have to follow the instructions of the previous step. In this mode you will be asked for needed inputs step by step.

To run the program in non-interactive mode you have to also specify arguments using flags like this:

npx restore-mnemonic --mnemonic="..." --output="./output.txt"

To get information about every argument, you can use help command:

npx restore-mnemonic help

Arguments

| Flag | Required | Description | Aliases | | --------- | -------- | ------------------------------------------------------------------------------------------------------------------- | ------- | | mnemonic | true | Mnemonic with one missing word replaced with _ | m | | output | false | Output file to put all the valid mnemonics to. If no output file is specified, the result will be printed to stdout | o | | formatted | false | Whether the output should be formatted json or raw. Only matters if no output is specified | f |

Output

Depending on if you specified output file, the result will be either put in the file or printed to the terminal.

If output is specified, the result will be written to file as a list of mnemonics.

If output is not specified, the result will be printed to stdout as a JSON array of strings. Depending on if formatted is specified, the json will be formatted or raw.