Skip to content

Commit 537af1e

Browse files
author
Michal Mrozek
committed
[ETCM-202] Update README
1 parent ccdd7a8 commit 537af1e

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,24 @@ Example:
2424

2525
Possible networks: `etc`, `eth`, `mordor`, `testnet-internal`
2626

27+
### Command Line Interface
28+
29+
`mantis-cli` is a tool that can be used to:
30+
31+
- generate a new private key
32+
```
33+
./bin/mantis mantis-cli generate-private-key
34+
```
35+
- derive an address from private key
36+
```
37+
./bin/mantis mantis-cli derive-address 00b11c32957057651d56cd83085ef3b259319057e0e887bd0fdaee657e6f75d0
38+
```
39+
- generate genesis allocs (using private keys or addresses)
40+
```
41+
(private keys) `./bin/mantis mantis-cli generate-alloc --balance=42 00b11c32957057651d56cd83085ef3b259319057e0e887bd0fdaee657e6f75d0 00b11c32957057651d56cd83085ef3b259319057e0e887bd0fdaee657e6f75d1`
42+
(addresses) `./bin/mantis mantis-cli generate-alloc --balance=42 --useAddresses 8b196738d90cf3d9fc299e0ec28e15ebdcbb0bdcb281d9d5084182c9c66d5d12`
43+
```
44+
2745
### Building the client
2846

2947
#### SBT
@@ -81,7 +99,7 @@ This patch will update the lock files for you.
8199

82100
- `repo.nix` : generated by the `sbtix-gen` command and includes only the build dependencies for the project.
83101
- `project/repo.nix` : generated by the `sbtix-gen-all` command and includes only the plugin dependencies. Also generates `repo.nix`.
84-
- `project/project/repo.nix` : generated by the `sbtix-gen-all2` command and includes only the pluginplugin dependencies. Also generates `repo.nix` and `project/repo.nix`.
102+
- `project/project/repo.nix` : generated by the `sbtix-gen-all2` command and includes only the plugin dependencies. Also generates `repo.nix` and `project/repo.nix`.
85103

86104
##### error: unsupported argument 'submodules' to 'fetchGit'
87105

0 commit comments

Comments
 (0)