status-im
/
keycard-cli
mirror of https://github.com/status-im/keycard-cli.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

update CLI README

This commit is contained in:
Andrea Franz 2019-03-01 18:48:40 +01:00
parent 56660433ba
commit d80cfdc13b
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,10 +1,10 @@
# status-hardware-wallet # keycard
`status-hardware-wallet` is a command line tool you can use to initialize a smartcard with the [Status Hardware Wallet](https://github.com/status-im/hardware-wallet). `keycard` is a command line tool you can use to initialize a smartcard with the [Status Keycard](https://github.com/status-im/status-keycard).
## Dependencies ## Dependencies
To install `hardware-wallet-go` you need `go` in your system. To install `keycard-go` you need `go` in your system.
MacOSX: MacOSX:
@ -12,20 +12,20 @@ MacOSX:
## Installation ## Installation
`go get github.com/status-im/hardware-wallet-go/cmd/status-hardware-wallet` `go get github.com/status-im/keycard-go/cmd/keycard`
The executable will be installed in `$GOPATH/bin`. The executable will be installed in `$GOPATH/bin`.
Check your `$GOPATH` with `go env`. Check your `$GOPATH` with `go env`.
## Usage ## Usage
### Install the hardware wallet applet ### Install the keycard applet
The install command will install an applet to the card. The install command will install an applet to the card.
You can download the status `cap` file from the [status-im/hardware-wallet releases page](https://github.com/status-im/hardware-wallet/releases). You can download the status `cap` file from the [status-im/status-keycard releases page](https://github.com/status-im/status-keycard/releases).
```bash ```bash
status-hardware-wallet install -l debug -a PATH_TO_CAP_FILE 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. In case the applet is already installed and you want to force a new installation you can pass the `-f` flag.
@ -33,7 +33,7 @@ In case the applet is already installed and you want to force a new installation
### Card info ### Card info
```bash ```bash
status-hardware-wallet info -l debug keycard info -l debug
``` ```
The `info` command will print something like this: The `info` command will print something like this:
@ -52,7 +52,7 @@ KeyUID: 0x
```bash ```bash
status-hardware-wallet init -l debug keycard init -l debug
``` ```
The `init` command initializes the card and generates the secrets needed to pair the card to a device. The `init` command initializes the card and generates the secrets needed to pair the card to a device.
@ -68,13 +68,13 @@ Pairing password: RandomPairingPassword
: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
status-hardware-wallet delete -l debug keycard delete -l debug
``` ```
### Pairing ### Pairing
```bash ```bash
status-hardware-wallet pair -l debug keycard pair -l debug
``` ```
The process will ask for `PairingPassword` and `PIN` and will generate a pairing key you can use to interact with the card. The process will ask for `PairingPassword` and `PIN` and will generate a pairing key you can use to interact with the card.