Skip to content

Commit e7141be

Browse files
committed
Add spacing for improved readability in CLI commands documentation
1 parent cc2d8e0 commit e7141be

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

docs/api/cli-commands.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
sidebar_position: 3
33
---
44
# CLI commands
5+
56
:::tip Instance notice
67

78
Please note that in order to use CLI commands, you will need **SSH Access to the server as well as an Astrakit admin acount on your Instance** and when prompted, you will need to **log in using your account data such as email, pasword and 2FA token**
@@ -25,6 +26,7 @@ You can access a variety of commands using the Admin-CLI that's provided with th
2526
## Authentication
2627

2728
The Admin CLI requires secure authentication with:
29+
2830
- Admin email address
2931
- Account password
3032
- 2FA code from authenticator app
@@ -40,6 +42,7 @@ user find <username/email/uuid>
4042
```
4143

4244
Displays detailed information about a specific user, including:
45+
4346
- UUID, username, email address
4447
- Account status and creation date
4548
- Last seen timestamp
@@ -56,6 +59,7 @@ user list [limit] [offset]
5659
```
5760

5861
Lists users in the system with pagination:
62+
5963
- `limit`: Maximum number of users to display (default: 10)
6064
- `offset`: Number of users to skip (default: 0)
6165

@@ -70,6 +74,7 @@ delete <username/email/uuid>
7074
```
7175

7276
Permanently deletes a user account. This:
77+
7378
- Removes the account from the database
7479
- Deletes all user sessions
7580
- Removes user files from storage
@@ -82,12 +87,15 @@ Permanently deletes a user account. This:
8287
```
8388
block <username/email/uuid>
8489
```
90+
8591
or
92+
8693
```
8794
ban <username/email/uuid>
8895
```
8996

9097
Bans a user from the platform. This:
98+
9199
- Sets their account status to "banned"
92100
- Invalidates all active sessions
93101
- Prevents future logins
@@ -98,12 +106,15 @@ Bans a user from the platform. This:
98106
```
99107
unblock <username/email/uuid>
100108
```
109+
101110
or
111+
102112
```
103113
unban <username/email/uuid>
104114
```
105115

106116
Unbans a previously banned user. This:
117+
107118
- Sets their account status back to "active"
108119
- Allows them to log in again
109120
- Sends notification email to the user
@@ -117,6 +128,7 @@ admin grant <username/email/uuid>
117128
```
118129

119130
Promotes a user to administrator status. This:
131+
120132
- Updates their admin flag in the database
121133
- Adds them to the admins table
122134
- Sends notification email to the user
@@ -128,6 +140,7 @@ admin revoke <username/email/uuid>
128140
```
129141

130142
Removes administrator privileges from a user. This:
143+
131144
- Updates their admin flag in the database
132145
- Removes them from the admins table
133146
- Sends notification email to the user
@@ -151,6 +164,7 @@ badge info <badge_id>
151164
```
152165

153166
Shows detailed information about a specific badge including:
167+
154168
- Title, description, icon, color
155169
- Creation date and creator
156170
- Sort order
@@ -163,6 +177,7 @@ badge create
163177
```
164178

165179
Interactive command to create a new badge, prompting for:
180+
166181
- Title
167182
- Description
168183
- Icon (optional, defaults to "military_tech")
@@ -176,6 +191,7 @@ badge edit <badge_id>
176191
```
177192

178193
Interactive command to edit an existing badge, allowing changes to:
194+
179195
- Title
180196
- Description
181197
- Icon
@@ -237,6 +253,7 @@ status
237253
```
238254

239255
Displays detailed information about the API server status, including:
256+
240257
- API version and uptime
241258
- Server load and memory usage
242259
- Database status and statistics
@@ -252,6 +269,7 @@ shutdown
252269
```
253270

254271
Gracefully shuts down the API server:
272+
255273
- Confirms the action before proceeding
256274
- Logs the shutdown action including admin name and timestamp
257275
- Sends a termination signal to the API process
@@ -268,6 +286,7 @@ clear
268286
```
269287

270288
Clears the terminal screen to improve readability:
289+
271290
- Works on both Windows and Unix-like systems
272291
- Re-displays the CLI header after clearing
273292

@@ -278,6 +297,7 @@ logout
278297
```
279298

280299
Logs out of the current admin session:
300+
281301
- Invalidates the current admin CLI session in the database
282302
- Logs the logout action
283303
- Returns to the authentication prompt
@@ -288,7 +308,9 @@ Logs out of the current admin session:
288308
```
289309
exit
290310
```
311+
291312
or
313+
292314
```
293315
quit
294316
```
@@ -361,4 +383,4 @@ astrakit-admin> badge assign 5 user123
361383

362384
```
363385
astrakit-admin> push broadcast Server maintenance in 30 minutes
364-
```
386+
```

0 commit comments

Comments
 (0)