From 142463e277bfcc73deab98b8846c2378a74a58d9 Mon Sep 17 00:00:00 2001 From: YanNaingWinn Date: Tue, 2 Dec 2025 20:53:39 +0700 Subject: [PATCH 1/7] Modified documentation UI and added overview --- docs/_static/custom.css | 11 ++++++ docs/overview.rst | 84 ++++++++++++++++++++++++++++++++++++++++- 2 files changed, 94 insertions(+), 1 deletion(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index ee90706..752b624 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -70,3 +70,14 @@ th { .wy-breadcrumbs .icon-home { color: #fcb770; } + +/* Menu list hover - white text */ +.wy-menu-vertical li.current a:hover, +.wy-menu-vertical li a:hover { + color: #ffffff; + background: #fcb770; +} + +.wy-menu-vertical a:hover { + color: #ffffff; +} diff --git a/docs/overview.rst b/docs/overview.rst index ff82135..6abae23 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -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 `_ + +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 [-f ]`` + +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 From 6a92237d0e54ddf6be9a0e384da8b37ad2b627cb Mon Sep 17 00:00:00 2001 From: YanNaingWinn Date: Tue, 2 Dec 2025 21:00:16 +0700 Subject: [PATCH 2/7] Modified documentation color --- docs/_static/custom.css | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 752b624..266b98b 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -72,12 +72,17 @@ th { } /* Menu list hover - white text */ -.wy-menu-vertical li.current a:hover, -.wy-menu-vertical li a:hover { - color: #ffffff; - background: #fcb770; +.wy-menu-vertical a:hover { + color: #ffffff !important; + background: #fcb770 !important; } -.wy-menu-vertical a:hover { - color: #ffffff; +.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; } From 215f30a52c67c469d13e28d92aff77d038da219d Mon Sep 17 00:00:00 2001 From: YanNaingWinn Date: Tue, 2 Dec 2025 21:04:40 +0700 Subject: [PATCH 3/7] Modified documentation UI --- docs/_static/custom.css | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index 266b98b..b31dfe0 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -71,18 +71,26 @@ th { 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 { +/* Menu list hover - white text (comprehensive coverage for all menu states) */ +.wy-menu-vertical a:hover, +.wy-menu-vertical li a:hover, +.wy-menu-vertical li.current a:hover, +.wy-menu-vertical li.current > a:hover, +.wy-menu-vertical li.toctree-l1 a:hover, +.wy-menu-vertical li.toctree-l2 a:hover, +.wy-menu-vertical li.toctree-l3 a:hover, +.wy-menu-vertical li.toctree-l4 a:hover, +.wy-menu-vertical li.toctree-l1.current a:hover, +.wy-menu-vertical li.toctree-l2.current a:hover, +.wy-menu-vertical li.toctree-l3.current a:hover, +.wy-menu-vertical li.toctree-l1.current > a:hover, +.wy-menu-vertical li.toctree-l2.current > a:hover, +.wy-menu-vertical li.toctree-l3.current > a:hover, +.wy-menu-vertical li.toctree-l1.current li.toctree-l2 a:hover, +.wy-menu-vertical li.toctree-l2.current li.toctree-l3 a:hover, +.wy-menu-vertical li.toctree-l1.current li.toctree-l2 > a:hover, +.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a:hover, +.wy-menu-vertical .current a:hover { color: #ffffff !important; background: #fcb770 !important; } From c922f230488e8fd791d8de724045741e30da59c1 Mon Sep 17 00:00:00 2001 From: YanNaingWinn Date: Tue, 2 Dec 2025 21:07:02 +0700 Subject: [PATCH 4/7] Removed some codes from css --- docs/_static/custom.css | 24 ------------------------ 1 file changed, 24 deletions(-) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index b31dfe0..ee90706 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -70,27 +70,3 @@ th { .wy-breadcrumbs .icon-home { color: #fcb770; } - -/* Menu list hover - white text (comprehensive coverage for all menu states) */ -.wy-menu-vertical a:hover, -.wy-menu-vertical li a:hover, -.wy-menu-vertical li.current a:hover, -.wy-menu-vertical li.current > a:hover, -.wy-menu-vertical li.toctree-l1 a:hover, -.wy-menu-vertical li.toctree-l2 a:hover, -.wy-menu-vertical li.toctree-l3 a:hover, -.wy-menu-vertical li.toctree-l4 a:hover, -.wy-menu-vertical li.toctree-l1.current a:hover, -.wy-menu-vertical li.toctree-l2.current a:hover, -.wy-menu-vertical li.toctree-l3.current a:hover, -.wy-menu-vertical li.toctree-l1.current > a:hover, -.wy-menu-vertical li.toctree-l2.current > a:hover, -.wy-menu-vertical li.toctree-l3.current > a:hover, -.wy-menu-vertical li.toctree-l1.current li.toctree-l2 a:hover, -.wy-menu-vertical li.toctree-l2.current li.toctree-l3 a:hover, -.wy-menu-vertical li.toctree-l1.current li.toctree-l2 > a:hover, -.wy-menu-vertical li.toctree-l2.current li.toctree-l3 > a:hover, -.wy-menu-vertical .current a:hover { - color: #ffffff !important; - background: #fcb770 !important; -} From b74819f2ad7a54c1e65e49a3ba5750865eeeedca Mon Sep 17 00:00:00 2001 From: YanNaingWinn Date: Tue, 2 Dec 2025 21:20:26 +0700 Subject: [PATCH 5/7] Modified documentation UI --- docs/_static/custom.css | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/_static/custom.css b/docs/_static/custom.css index ee90706..266b98b 100644 --- a/docs/_static/custom.css +++ b/docs/_static/custom.css @@ -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; +} From 68dbe592d86d1f922c9cbed6dcf94dcb9786bcc1 Mon Sep 17 00:00:00 2001 From: YanNaingWinn Date: Wed, 3 Dec 2025 02:16:43 +0700 Subject: [PATCH 6/7] Added Other/Proprietary License --- setup.cfg | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.cfg b/setup.cfg index 541b042..c4cfee9 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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 From 84baac7a4839258622cc4aea72062024d96b695a Mon Sep 17 00:00:00 2001 From: YanNaingWinn Date: Wed, 3 Dec 2025 16:37:41 +0700 Subject: [PATCH 7/7] Modified license in documentation --- docs/license.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/license.rst b/docs/license.rst index 54fe6d3..84e5e0c 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -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