Skip to content

Commit 2e5e310

Browse files
committed
chore: add README.md
1 parent 2b88c34 commit 2e5e310

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

cli/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# torus-cli
2+
3+
Torus blockchain cli using the torus client.
4+
5+
## Available commands
6+
7+
| Command | Description |
8+
| ------- | ----------- |
9+
| `torurs key list` | Lists all saved keys. |
10+
| `torurs key info <name>` | Prints information about a key prompting for the password if it is encrypted. |
11+
| `torurs key create <name> [-p]` | Generates a new sr25519 key and prompts for a encryption password if `-p` is given. |
12+
| `torurs key delete <name> [-y]` | Deletes a saved key. |
13+
| `torurs balance <account>` | Shows the account balance. |
14+
| `torurs balance check <account>` | Does the same as the command above. |
15+
| `torurs balance transfer <key> <target_account> <amount> [-y]` | Transfers **amount** from **key** to **address**. |
16+
| `torurs stake <account>` | Prints all keys **account** is staking with the amount. |
17+
| `torurs stake given <account>` | Does the same as the command above. |
18+
| `torurs stake received <account>` | Prints all keys **account** is staked by with the amount. |
19+
| `torurs stake add <key> <target_account> <amount> [-y]` | Stakes **target_account** with **amount** from **key**. |
20+
| `torurs stake remove <key> <target_account> <amount> [-y]` | Removes **amount** staked to **target_account** from **key**. |
21+
| `torurs stake transfer <key> <source_account> <target_account> <amount> [-y]` | Transfers **amount** **key** has staked on **source_account** to **target_account**. |
22+
23+
> `--testnet` can be added in order to run the command on the testnet.
24+
25+
> **address**: a ss58 address.
26+
> **key**: The name of a saved key.
27+
> **account**: either a ss58 address or the name of a saved key.
28+
> [-y]: The confirmation prompt is auto accepted if it is provided.

0 commit comments

Comments
 (0)