1- # python-onlykey
2-
3- Python client for interacting with the OnlyKey.
4-
5- OnlyKey-cli - A command line interface to the OnlyKey that can be used for configuration (Similar functionality to [ OnlyKey App] ( https://docs.crp.to/app.html ) )
1+ # onlykey-cli
62
3+ OnlyKey-cli - A command line interface to the OnlyKey (Similar functionality to [ OnlyKey App] ( https://docs.crp.to/app.html ) ) that can be used for configuration, scripting, and testing.
74
85## Installation
96
@@ -37,7 +34,7 @@ $ sudo apt install python3-pip python3-tk libusb-1.0-0-dev libudev-dev
3734$ pip3 install onlykey
3835$ wget https://raw.githubusercontent.com/trustcrypto/trustcrypto.github.io/master/49-onlykey.rules
3936$ sudo cp 49-onlykey.rules /etc/udev/rules.d/
40- $ sudo bash -c ' udevadm control --reload-rules && udevadm trigger'
37+ $ sudo udevadm control --reload-rules && udevadm trigger
4138```
4239
4340### Debian Install with dependencies
@@ -47,7 +44,7 @@ $ sudo apt install python3-pip python3-tk libusb-1.0-0-dev libudev-dev
4744$ pip3 install onlykey
4845$ wget https://raw.githubusercontent.com/trustcrypto/trustcrypto.github.io/master/49-onlykey.rules
4946$ sudo cp 49-onlykey.rules /etc/udev/rules.d/
50- $ sudo bash -c ' udevadm control --reload-rules && udevadm trigger'
47+ $ sudo udevadm control --reload-rules && udevadm trigger
5148```
5249
5350### RedHat Install with dependencies
@@ -58,7 +55,7 @@ $ yum install python3-pip python3-devel python3-tk libusb-devel libudev-devel \
5855$ pip3 install onlykey
5956$ wget https://raw.githubusercontent.com/trustcrypto/trustcrypto.github.io/master/49-onlykey.rules
6057$ sudo cp 49-onlykey.rules /etc/udev/rules.d/
61- $ sudo bash -c ' udevadm control --reload-rules && udevadm trigger'
58+ $ sudo udevadm control --reload-rules && udevadm trigger
6259```
6360
6461### Fedora Install with dependencies
@@ -68,7 +65,7 @@ $ dnf install python3-pip python3-devel python3-tkinter libusb-devel libudev-dev
6865$ pip3 install onlykey
6966$ wget https://raw.githubusercontent.com/trustcrypto/trustcrypto.github.io/master/49-onlykey.rules
7067$ sudo cp 49-onlykey.rules /etc/udev/rules.d/
71- $ sudo bash -c ' udevadm control --reload-rules && udevadm trigger'
68+ $ sudo udevadm control --reload-rules && udevadm trigger
7269```
7370
7471### OpenSUSE Install with dependencies
@@ -77,7 +74,7 @@ $ zypper install python3-pip python3-devel python3-tk libusb-1_0-devel libudev-d
7774$ pip3 install onlykey
7875$ wget https://raw.githubusercontent.com/trustcrypto/trustcrypto.github.io/master/49-onlykey.rules
7976$ sudo cp 49-onlykey.rules /etc/udev/rules.d/
80- $ sudo bash -c ' udevadm control --reload-rules && udevadm trigger'
77+ $ sudo udevadm control --reload-rules && udevadm trigger
8178```
8279
8380### Arch Linux Install with dependencies
@@ -86,7 +83,7 @@ $ sudo pacman -Sy git python3-setuptools python3 libusb python3-pip
8683$ pip3 install onlykey
8784$ wget https://raw.githubusercontent.com/trustcrypto/trustcrypto.github.io/master/49-onlykey.rules
8885$ sudo cp 49-onlykey.rules /etc/udev/rules.d/
89- $ sudo bash -c ' udevadm control --reload-rules && udevadm trigger'
86+ $ sudo udevadm control --reload-rules && udevadm trigger
9087```
9188
9289### FreeBSD Install with dependencies
@@ -101,15 +98,19 @@ In order for non-root users in Linux to be able to communicate with OnlyKey a ud
10198
10299### Command Options
103100
104- - init - A command line tool for setting PIN on OnlyKey (Initial Configuration)
101+ #### init
102+ A command line tool for setting PIN on OnlyKey (Initial Configuration)
105103
106- - settime - A command for setting time on OnlyKey, time is needed for TOTP (Google Authenticator)
104+ #### settime
105+ A command for setting time on OnlyKey, time is needed for TOTP (Google Authenticator)
107106
108- - getlabels - Returns slot labels
107+ #### getlabels
108+ Returns slot labels
109109
110- - getkeylabels - Returns key labels for RSA keys 1-4 and ECC keys 1 -32
110+ #### getkeylabels
111+ Returns key labels for RSA keys 1-4 and ECC keys 1 -32
111112
112- - setslot [ id] [ type] [ value]
113+ #### setslot [ id] [ type] [ value]
113114 - [ id] must be slot number 1a - 6b
114115 - [ type] must be one of the following:
115116 - label - Slot label i.e. My Google Acct
@@ -130,23 +131,26 @@ In order for non-root users in Linux to be able to communicate with OnlyKey a ud
130131 - totpkey - Google Authenticator key
131132 - add_char5 - Additional character after OTP 2 for RETURN
132133
133- - wipeslot [ id]
134+ #### wipeslot [ id]
134135 - <id > must be slot number 1a - 6b
135136
136- - setkey [ key slot] [ key type]
137+ #### setkey [ key slot] [ key type]
137138 - See examples [ here] ( https://docs.crp.to/command-line.html#writing-private-keys-and-passwords )
138139
139- - wipekey [ key slot]
140+ #### wipekey [ key slot]
140141
141- - idletimeout - OnlyKey locks after ideletimeout is reached (1 – 255 minutes; default = 30; 0 to disable)
142+ #### idletimeout
143+ OnlyKey locks after ideletimeout is reached (1 – 255 minutes; default = 30; 0 to disable)
142144
143- - wipemode - Configure how the OnlyKey responds to
145+ #### wipemode
146+ Configure how the OnlyKey responds to
144147a factory reset. WARNING - Setting to Full Wipe mode cannot be changed.
145148 - 1 - Sensitive Data Only (default)
146149All sensitive data is wiped.
147150 - 2 - Full Wipe (recommended for plausible deniability users) Entire device is wiped. Firmware must be reloaded.
148151
149- - keylayout - Set keyboard layout
152+ #### keylayout
153+ Set keyboard layout
150154 - 1 - USA_ENGLISH (Default)
151155 - 2 - CANADIAN_FRENCH
152156 - 3 - CANADIAN_MULTILINGUAL
@@ -173,7 +177,8 @@ All sensitive data is wiped.
173177 - 24 - SERBIAN_LATIN_ONLY
174178 - 25 - HUNGARIAN
175179
176- - keytypespeed - 1 = slowest; 10 = fastest [ 4 = default]
180+ #### keytypespeed
181+ 1 = slowest; 10 = fastest [ 4 = default]
177182
178183### Running Commands
179184
@@ -401,4 +406,4 @@ This can be added to scripts such as the UDEV rule to automatically set time whe
401406
402407## Source
403408
404- [ Python OnlyKey on Github] ( https://github.com/trustcrypto/python-onlykey )
409+ [ OnlyKey CLI on Github] ( https://github.com/trustcrypto/python-onlykey )
0 commit comments