Skip to content

Commit e1b0d26

Browse files
committed
update readme with new commands
Signed-off-by: Maximilian Deubel <[email protected]>
1 parent a67cca7 commit e1b0d26

File tree

2 files changed

+36
-7
lines changed

2 files changed

+36
-7
lines changed

README.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,28 @@ For the device to respond to AT commands, the firmware on the device must have a
1515
## Command Line Interface
1616

1717
```
18-
usage: nrfcredstore [-h] [--baudrate BAUDRATE] [--timeout TIMEOUT] dev {list,write,delete,generate} ...
18+
usage: nrfcredstore [-h] [--baudrate BAUDRATE] [--timeout TIMEOUT] dev {list,write,delete,deleteall,imei,attoken,generate} ...
1919
2020
Manage certificates stored in a cellular modem.
2121
2222
positional arguments:
23-
dev Serial device used to communicate with the modem.
23+
dev Device used to communicate with the modem. For interactive selection of serial port, use "auto". For RTT, use "rtt". If given a SEGGER
24+
serial number, it is assumed to be an RTT device.
2425
2526
options:
2627
-h, --help show this help message and exit
2728
--baudrate BAUDRATE Serial baudrate
2829
--timeout TIMEOUT Serial communication timeout in seconds
2930
3031
subcommands:
31-
{list,write,delete,generate}
32+
{list,write,delete,deleteall,imei,attoken,generate}
3233
Certificate related commands
3334
list List all keys stored in the modem
3435
write Write key/cert to a secure tag
3536
delete Delete value from a secure tag
37+
deleteall Delete all keys in a secure tag
38+
imei Get IMEI from the modem
39+
attoken Get attestation token of the modem
3640
generate Generate private key
3741
```
3842

@@ -56,7 +60,7 @@ Secure tag Key type SHA
5660

5761
### write subcommand
5862

59-
Write key/cert to a secure tag. KEY_TYPE must be either ROOT_CA_CERT, CLIENT_CERT, CLIENT_KEY, or PSK.
63+
Write key/cert to a security tag. KEY_TYPE must be either ROOT_CA_CERT, CLIENT_CERT, CLIENT_KEY, or PSK.
6064

6165
```
6266
usage: nrfcredstore [--baudrate BAUDRATE] [--timeout TIMEOUT] dev write SECURE_TAG KEY_TYPE FILENAME
@@ -68,7 +72,7 @@ usage: nrfcredstore [--baudrate BAUDRATE] [--timeout TIMEOUT] dev write SECURE_T
6872

6973
### delete subcommand
7074

71-
Delete value from a secure tag.
75+
Delete value from a security tag.
7276

7377
```
7478
usage: nrfcredstore [--baudrate BAUDRATE] [--timeout TIMEOUT] dev delete SECURE_TAG KEY_TYPE
@@ -78,6 +82,31 @@ usage: nrfcredstore [--baudrate BAUDRATE] [--timeout TIMEOUT] dev delete SECURE_
7882

7983
$ nrfcredstore /dev/tty.usbmodem0009600000001 delete 123 ROOT_CA_CERT
8084

85+
### deletall subcommand
86+
87+
Delete all writable security tags.
88+
89+
```
90+
usage: nrfcredstore [--baudrate BAUDRATE] [--timeout TIMEOUT] dev deleteall
91+
```
92+
93+
### imei subcommand
94+
95+
Read IMEI from modem.
96+
97+
```
98+
usage: nrfcredstore [--baudrate BAUDRATE] [--timeout TIMEOUT] dev imei
99+
```
100+
101+
### attoken subcommand
102+
103+
Read Attestation Token from modem.
104+
105+
```
106+
usage: nrfcredstore [--baudrate BAUDRATE] [--timeout TIMEOUT] dev attoken
107+
```
108+
109+
81110
### generate subcommand
82111

83112
> [!IMPORTANT]
@@ -114,4 +143,4 @@ Running the tests depends on a [development installation](#development-installat
114143

115144
Check coverage
116145

117-
poetry run pytest --cov=. tests
146+
poetry run pytest --cov=. tests

src/nrfcredstore/cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
def parse_args(in_args):
2323
parser = argparse.ArgumentParser(description='Manage certificates stored in a cellular modem.')
24-
parser.add_argument('dev', help='Device used to communicate with the modem.')
24+
parser.add_argument('dev', help='Device used to communicate with the modem. For interactive selection of serial port, use "auto". For RTT, use "rtt". If given a SEGGER serial number, it is assumed to be an RTT device.')
2525
parser.add_argument('--baudrate', type=int, default=115200, help='Serial baudrate')
2626
parser.add_argument('--timeout', type=int, default=3,
2727
help='Serial communication timeout in seconds')

0 commit comments

Comments
 (0)