Skip to content

cryptnox/cryptnox-cli

Repository files navigation

Image

cryptnox-cli

CLI for managing Cryptnox Hardware Wallet smart cards



PyPI Python versions MStore Documentation status License: GPLv3

cryptnox-cli is a command-line interface for managing Cryptnox Hardware Wallet smart cards, enabling secure seed initialization and cryptographic signing for Bitcoin and Ethereum.


Supported hardware

Cryptnox Hardware Wallet smart cards

Works with Cryptnox Hardware Wallet smart cards running firmware v1.6.0 or later.

Smart card Wallet version
Crypto Hardware Wallet – Dual Card Set v1.6.1

Smart card readers

Works with Cryptnox readers and any other standard PC/SC smart card reader:

Reader Type Interface
Cryptnox® Smartcard Reader Contact (ID-1 + SIM) USB-A
Compact USB Mini Smartcard Reader Contact (ID-1) USB-A
Cryptnox NFC Contactless Reader Contactless (NFC/ISO 14443) USB-C

Installation

Important

This is only a minimal setup. Additional packages may be required depending on your operating system. See Installation and requirements.

From PyPI

pip install cryptnox-cli

From MStore

mstore install cryptnox-cli

Visit the MStore page to install cryptnox-cli via the graphical user interface.

From source

git clone https://github.com/cryptnox/cryptnox-cli.git
cd cryptnox-cli
pip install .

This installs the package and makes the cryptnox command available (if your Python installation is in your system PATH).


Quick usage examples

Tip

The examples below are only a subset of available commands. The complete list of commands and detailed usage instructions is described in the official documentation.

1. Sign and send a Bitcoin transaction

  1. Create or obtain a raw unsigned transaction externally.
  2. Run the signing & send command:
    cryptnox btc send <recipient_address> <amount> [-f <fees>]

BTC send transaction demo

2. Dual initialization

  1. Factory reset each card:
    cryptnox reset → enter PUK → verify reset.

  2. Initialize each card:
    cryptnox init → (optional) set name/email → set PIN (4–9 digits) → set or generate PUK → verify init.

  3. Run dual seed procedure:
    cryptnox seed dual — follow prompts: insert Card A (enter PIN), swap to Card B (enter PIN), swap back as requested.

3. Change PIN code

  1. Run command: cryptnox change_pin
  2. Enter current PIN → enter new PIN → verify change.
  3. Check with cryptnox info using new PIN (BTC & ETH accounts displayed).

4. Get extended public key (xpub)

  1. Run command: cryptnox get_xpub
  2. Enter PIN → enter PUK
  3. The card returns the xpub

Documentation

The full User & Developer documentation is available at the Cryptnox CLI Documentation. It covers installation and setup, usage guides and examples, CLI command reference, and developer notes with API details.


License

cryptnox-cli is dual-licensed:

  • LGPL-3.0 for open-source projects and proprietary projects that comply with LGPL requirements
  • Commercial license for projects that require a proprietary license without LGPL obligations (see COMMERCIAL.md for details)

For commercial inquiries, contact: contact@cryptnox.com

About

CLI for managing Cryptnox Hardware Wallet smart cards.

Topics

Resources

License

LGPL-3.0, Unknown licenses found

Licenses found

LGPL-3.0
LICENSE
Unknown
license.rtf

Stars

Watchers

Forks

Packages

 
 
 

Contributors