Skip to content

Commit cf840a9

Browse files
committed
Update "How to use" section
1 parent da36540 commit cf840a9

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
codechain-keystore-cli [![Build Status](https://travis-ci.org/CodeChain-io/codechain-keystore-cli.svg?branch=master)](https://travis-ci.org/CodeChain-io/codechain-keystore-cli)
2-
=========================
1+
# codechain-keystore-cli [![Build Status](https://travis-ci.org/CodeChain-io/codechain-keystore-cli.svg?branch=master)](https://travis-ci.org/CodeChain-io/codechain-keystore-cli)
32

43
A command line CodeChain key management tool
54

6-
7-
How to install
8-
----------------
5+
## How to install
96

107
### Binary install
118

@@ -23,25 +20,25 @@ npm install -g codechain-sdk-cli
2320
yarn global add codechain-sdk-cli
2421
```
2522

26-
How to use
27-
------
23+
## How to use
2824

2925
```sh
30-
Usage: cckey [options] [action]
26+
Usage: cckey [options] [command]
3127

3228
Options:
3329

34-
-V, --version output the version number
35-
-t --account-type <account-type> 'platform' or 'asset'. The type of the key
36-
-p --passphrase <passphrase> passphrase
37-
-a --address <address> address
38-
-h, --help output usage information
30+
-V, --version output the version number
31+
-t, --account-type <accountType> 'platform' or 'asset'. The type of the key (default: platform)
32+
-h, --help output usage information
3933

40-
Action:
34+
Commands:
4135

42-
list : List all the saved addresses
43-
create : Create new key with passphrase
44-
delete : Delete the key of the given address
36+
list list keys
37+
create [options] create a new key
38+
delete [options] delete the key
39+
import [options] <path> import a key
40+
import-raw [options] <privateKey> import a raw private key (32 byte hexadecimal string)
41+
export [options] export the key
4542

4643
Examples:
4744

@@ -51,4 +48,9 @@ How to use
5148

5249
cckey delete -t platform --address "tcc..."
5350

51+
cckey import UTC--2018-08-14T06-30-23Z--bbb6685e-7165-819d-0988-fc1a7d2d0523 -t platform --passphrase "satoshi"
52+
53+
cckey export -t platform --address tccqz76va4lh6dwkuwetmfrcgpn852emyq9hvjuksfg --passphrase "satoshi"
54+
55+
cckey import-raw -t platform a05f81608217738d99da8fd227897b87e8890d3c9159b559c7c8bbd408e5fb6e --passphrase "satoshi"
5456
```

0 commit comments

Comments
 (0)