status-im/keycard-cli
2
0
Fork 0
mirror of https://github.com/status-im/keycard-cli.git synced 2025-03-01 04:10:33 +00:00
Code Issues Projects Releases Wiki Activity

add README table of contents

Browse Source
This commit is contained in:
Andrea Franz 2019-03-18 21:55:45 +01:00 committed by GitHub
parent 5b9dc3a4d9
commit 1c6700c165
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -2,6 +2,14 @@
`keycard-cli` is a command line tool to manage [Status Keycards](https://github.com/status-im/status-keycard). `keycard-cli` is a command line tool to manage [Status Keycards](https://github.com/status-im/status-keycard).
* [Dependencies](#dependencies)
* [Installation](#intallation)
* [Card info](#card-info)
* [Keycard applet installation](#keycard-applet-installation)
* [Card initialization](#card-initialization)
* [Deleting the applet](#deleting-the-applet)
* [Keycard shell](#keycard-shell)
## Dependencies ## Dependencies
To install `keycard-cli` you need `go` in your system. To install `keycard-cli` you need `go` in your system.
@ -19,17 +27,6 @@ Check your `$GOPATH` with `go env`.
## Usage ## Usage
### Install the keycard applet
The install command will install an applet to the card.
You can download the status `cap` file from the [status-im/status-keycard releases page](https://github.com/status-im/status-keycard/releases).
```bash
keycard install -l debug -a PATH_TO_CAP_FILE
```
In case the applet is already installed and you want to force a new installation you can pass the `-f` flag.
### Card info ### Card info
```bash ```bash
@ -47,6 +44,17 @@ Version: 0x
AvailableSlots: 0x AvailableSlots: 0x
KeyUID: 0x KeyUID: 0x
``` ```
### Keycard applet installation
The `install` command will install an applet to the card.
You can download the status `cap` file from the [status-im/status-keycard releases page](https://github.com/status-im/status-keycard/releases).
```bash
keycard install -l debug -a PATH_TO_CAP_FILE
```
In case the applet is already installed and you want to force a new installation you can pass the `-f` flag.
### Card initialization ### Card initialization
@ -63,10 +71,13 @@ PUK 123456789012
Pairing password: RandomPairingPassword Pairing password: RandomPairingPassword
``` ```
### Deleting the applet from the card ### Deleting the applet
:warning: **WARNING! This command will remove the applet and all the keys from the card.** :warning: :warning: **WARNING! This command will remove the applet and all the keys from the card.** :warning:
```bash ```bash
keycard delete -l debug keycard delete -l debug
``` ```
### Keycard shell
TODO