Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,19 @@ th {
.wy-breadcrumbs .icon-home {
color: #fcb770;
}

/* Menu list hover - white text */
.wy-menu-vertical a:hover {
color: #ffffff !important;
background: #fcb770 !important;
}

.wy-menu-vertical li.current a:hover {
color: #ffffff !important;
background: #fcb770 !important;
}

.wy-menu-vertical li.current > a:hover {
color: #ffffff !important;
background: #fcb770 !important;
}
2 changes: 1 addition & 1 deletion docs/license.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
License
=======

This project is available under the terms of the GNU General Public License (GPL) v3.
This project is available under the terms of the GNU LESSER GENERAL PUBLIC LICENSE (GPL) v3.

.. literalinclude:: ../LICENSE
:language: none
Expand Down
84 changes: 83 additions & 1 deletion docs/overview.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,89 @@
Cryptnox CLI Overview
=====================

.. include:: ../README.rst
``cryptnox-cli`` is a command-line interface for managing **Cryptnox Smart cards**, enabling secure seed initialization and cryptographic signing for **Bitcoin** and **Ethereum**.

Supported Hardware
------------------

- **Cryptnox Smart cards** 💳
- **Standard PC/SC Smart card Readers**: either USB NFC reader or a USB smart card reader

Get your card and readers here: `shop.cryptnox.com <https://shop.cryptnox.com>`_

Installation
------------

.. note::
This is only a minimal setup. Additional packages may be required depending on your operating system.

From PyPI
~~~~~~~~~

.. code-block:: bash

pip install cryptnox-cli

From source
~~~~~~~~~~~

.. code-block:: bash

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
--------------------

.. note::
The examples below are only a subset of available commands. The complete list of commands and detailed usage instructions is described in the :doc:`cli` section.

1. 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.

2. 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>]``

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**

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
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ classifiers =
Development Status :: 5 - Production/Stable
Environment :: Console
License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3)
License :: Other/Proprietary License
Operating System :: OS Independent
Programming Language :: Python :: 3.11
Programming Language :: Python :: 3.12
Expand Down