Skip to content

Commit f119628

Browse files
Add denode commands instructions (#27)
* Add disks management guide * Add denode commands CLI instructions * Change title
1 parent 3a83976 commit f119628

1 file changed

Lines changed: 114 additions & 0 deletions

File tree

guide/denode-command.md

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# DeNode CLI Account and Config Management Guide
2+
3+
## Overview
4+
The `account` and `config` commands allow users to manage Ethereum wallets and node configuration files for the Denode (peaq DePIN node).
5+
6+
Global flags available for all commands:
7+
- `-d, --debug` Enable debug output
8+
- `-h, --help`  Show help
9+
10+
## Account Management Commands
11+
12+
### Command: account delete
13+
14+
**Purpose:** Delete your ethereum account
15+
16+
**Usage:**
17+
```
18+
./denode account delete
19+
```
20+
21+
### Command: account export
22+
23+
**Purpose:** Export your ethereum account private key
24+
25+
**Usage:**
26+
```
27+
./denode account export
28+
```
29+
30+
### Command: account import
31+
32+
**Purpose:** Imports your wallet by private key
33+
34+
**Usage:**
35+
```
36+
./denode account import
37+
```
38+
39+
## Config Management Commands
40+
41+
### Command: config clear
42+
43+
**Purpose:** Deletes all user's configuration files when it's needed to start from scratch
44+
45+
**Usage:**
46+
```
47+
./denode config clear
48+
```
49+
50+
### Command: config code
51+
52+
**Purpose:** Generates a code for obtaining a role on the Discord server
53+
54+
**Usage:**
55+
```
56+
./denode config code
57+
```
58+
59+
### Command: config generate
60+
61+
**Purpose:** Generates a new config file in the working directory (all command line parameters are required for non-interactive mode)
62+
63+
**Flags:**
64+
* `--address` string  (required) Account address to create config for
65+
* `--license` string  (required for non-interactive) License ID
66+
* `--storage` string  (required for non-interactive) Storage directory path
67+
* `--share` int    Storage share size in GiB (minimum 1)
68+
* `--rpc` string    peaq blockchain RPC URL
69+
* `--ip` string    Node server IP address (default "0.0.0.0")
70+
* `--port` int    Port number (10000-65535) (default 55050)
71+
72+
**Usage example:**
73+
```
74+
./denode config generate \
75+
--address 0x123...abc \
76+
--license 12345 \
77+
--storage /home/user/denode_storage \
78+
--share 200 \
79+
--rpc https://rpc-peaq.peaq.network \
80+
--ip 0.0.0.0 \
81+
--port 55050
82+
```
83+
84+
### Command: config get
85+
86+
**Purpose:** Display the decrypted configuration
87+
88+
**Flags:**
89+
* `--address` string  Account address to get config for
90+
* `--license` string  (required for non-interactive mode) License ID
91+
92+
**Usage (interactive mode):**
93+
```
94+
./denode config get --address 0x123...abc
95+
```
96+
97+
**Usage (non-interactive mode):**
98+
```
99+
./denode config get --address 0x123...abc --license 12345
100+
```
101+
102+
### Command: config set
103+
104+
**Purpose:** Modifies specified fields in a configuration file (only in interactive mode)
105+
106+
**Flags:**
107+
* `--address` string  (required) Account address to modify config for
108+
109+
**Usage:**
110+
```
111+
./denode config set --address 0x123...abc
112+
```
113+
114+
The command will launch an interactive menu where you can change individual fields (license, storage path, share size, RPC, port, etc.).

0 commit comments

Comments
 (0)