A CLI tool that generates a bip39 mnemonic phrase, shuffles the order of the words but maintains each word's position in the original phrase & prints the words and their position across n number of csv pages.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

(back to top)

Built With

• Node.js
• Typescript
• bip39
• commander
• csv-writer
• date-fns
• dotenv
• node-color-log
• prettier
• eslint

(back to top)

Getting Started

To get a local copy up and running follow these example steps.

Prerequisites

This project assumes you have node and npm installed already. If not, here's some resources:

• node download
• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/ahmedjahmi/mnemonic.git

2. Install NPM packages

   npm install

3. Copy the contents of config.ts.example into a config.ts file, and the contents of .env.example into a .env file at the root of your project directory.
   • In config.ts, the csvDirPath should be set to the exact full path to the directory where you would like to store your csv files (this can be anywhere on your computer).
   • example:

   csvDirPath: '/path/to/where/you/save/csv-files/';

   • envPath should be set to the exact full path and file name of your .env file (this should be in your project's root directory).
   • example:

   envPath: '/user/projects/mnemonic/.env';

4. Build the project now and after any changes are made in the future.

   npm run build

(back to top)

Usage

Once installation is complete, run the program:

  mnemonic gen

The default is 24 words and their positions, spread randomly across 3 csv pages.

Arguments:

• wordCount: choice of 24 or 12 words, 24 words is the default.
• pageCount: choice of 2 - 6 csv pages to spread the phrase words across, 3 pages is the default.

example: 12 words, across 4 pages

  mnemonic gen 12 4

(back to top)

Roadmap

• Add support for word lists of more languages
• Address generation from phrase

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ahmed Jahmi - twitter: @jahmiamor | email: [email protected]

Project Link: https://github.com/ahmedjahmi/mnemonic

(back to top)