95 lines
2.1 KiB
Markdown
95 lines
2.1 KiB
Markdown
# keycard-cli
|
|
|
|
`keycard-cli` is a command line tool to manage [Status Keycards](https://github.com/status-im/status-keycard).
|
|
|
|
* [Dependencies](#dependencies)
|
|
* [Installation](#installation)
|
|
* [Continuous Integration](#continuous-integration)
|
|
* CLI Commands
|
|
* [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
|
|
|
|
To install `keycard-cli` you need `go` in your system.
|
|
|
|
MacOSX:
|
|
|
|
`brew install go`
|
|
|
|
## Installation
|
|
|
|
`go get -u github.com/status-im/keycard-cli`
|
|
|
|
The executable will be installed in `$GOPATH/bin`.
|
|
Check your `$GOPATH` with `go env`.
|
|
|
|
## Continuous Integration
|
|
|
|
Jenkins builds provide:
|
|
|
|
* [PR Builds](https://ci.status.im/job/status-keycard/job/prs/job/keycard-cli/) - Run only the `test` and `build` targets.
|
|
* [Manual Builds](https://ci.status.im/job/status-keycard/job/keycard-cli/) - Create GitHub release draft with binaries for 3 platforms.
|
|
|
|
Successful PR builds are mandatory.
|
|
|
|
## Usage
|
|
|
|
### Card info
|
|
|
|
```bash
|
|
keycard-cli info -l debug
|
|
```
|
|
|
|
The `info` command will print something like this:
|
|
|
|
```
|
|
Installed: true
|
|
Initialized: false
|
|
InstanceUID: 0x
|
|
PublicKey: 0x112233...
|
|
Version: 0x
|
|
AvailableSlots: 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-cli 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
|
|
|
|
|
|
```bash
|
|
keycard-cli init -l debug
|
|
```
|
|
|
|
The `init` command initializes the card and generates the secrets needed to pair the card to a device.
|
|
|
|
```
|
|
PIN 123456
|
|
PUK 123456789012
|
|
Pairing password: RandomPairingPassword
|
|
```
|
|
|
|
### Deleting the applet
|
|
|
|
:warning: **WARNING! This command will remove the applet and all the keys from the card.** :warning:
|
|
|
|
```bash
|
|
keycard-cli delete -l debug
|
|
```
|
|
|
|
### Keycard shell
|
|
TODO
|