Skip to content

Commit 3ddbf7a

Browse files
M03EDM03ED
committed
fix: interfaces
1 parent 32f221d commit 3ddbf7a

17 files changed

Lines changed: 197 additions & 197 deletions

File tree

content/docs/en/cli-tui/CLI.mdx renamed to content/docs/en/interfaces/CLI.mdx

Lines changed: 85 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,86 +1,86 @@
1-
---
2-
title: CLI
3-
navigation: CLI
4-
icon: Terminal
5-
---
6-
7-
# PasarGuard CLI
8-
9-
Modern command-line tools for managing PasarGuard with efficiency and style.
10-
11-
---
12-
13-
## CLI - Command-Line Interface
14-
15-
A modern, type-safe command-line interface for managing PasarGuard, built with Typer.
16-
17-
### Features
18-
19-
- 🎯 **Type-safe CLI** with rich output formatting
20-
- 📊 **Beautiful tables and panels** for data visualization
21-
- 🔒 **Secure admin management** with interactive prompts
22-
- 📈 **System status monitoring** and diagnostics
23-
- ⌨️ **Interactive prompts** with confirmations for safety
24-
25-
### Installation
26-
27-
The CLI is included with PasarGuard and can be used directly:
28-
29-
```bash
30-
pasarguard cli --help
31-
32-
# Or from the project root
33-
uv run pasarguard-cli.py --help
34-
```
35-
36-
### Usage
37-
38-
#### General Commands
39-
40-
```bash
41-
# Show version
42-
pasarguard cli version
43-
44-
# Show help
45-
pasarguard cli --help
46-
```
47-
48-
#### Admin Management
49-
50-
```bash
51-
# List all admins
52-
pasarguard cli admins --list
53-
54-
# Create new admin
55-
pasarguard cli admins --create username
56-
57-
# Delete admin
58-
pasarguard cli admins --delete username
59-
60-
# Modify admin (password and sudo status)
61-
pasarguard cli admins --modify username
62-
63-
# Reset admin usage statistics
64-
pasarguard cli admins --reset-usage username
65-
```
66-
67-
#### System Information
68-
69-
```bash
70-
# Show system status
71-
pasarguard cli system
72-
```
73-
74-
### Examples
75-
76-
**Creating a new admin:**
77-
```bash
78-
pasarguard cli admins --create john_admin
79-
# You'll be prompted to enter password and sudo permissions
80-
```
81-
82-
**Listing all admins with formatted output:**
83-
```bash
84-
pasarguard cli admins --list
85-
# Displays a beautiful table with admin details
1+
---
2+
title: CLI
3+
navigation: CLI
4+
icon: Terminal
5+
---
6+
7+
# PasarGuard CLI
8+
9+
Modern command-line tools for managing PasarGuard with efficiency and style.
10+
11+
---
12+
13+
## CLI - Command-Line Interface
14+
15+
A modern and secure command-line interface for managing PasarGuard, built with Typer.
16+
17+
### Features
18+
19+
- 🎯 **Secure CLI** with beautiful output formatting
20+
- 📊 **Beautiful tables and panels** for data display
21+
- 🔒 **Secure admin management** with interactive prompts
22+
- 📈 **System status monitoring** and problem detection
23+
- ⌨️ **Interactive prompts** with confirmations for enhanced security
24+
25+
### Installation
26+
27+
The CLI is installed with PasarGuard and you can use it directly:
28+
29+
```bash
30+
pasarguard cli --help
31+
32+
# Or from the project root
33+
uv run pasarguard-cli.py --help
34+
```
35+
36+
### Usage
37+
38+
#### General Commands
39+
40+
```bash
41+
# Show version
42+
pasarguard cli version
43+
44+
# Show help
45+
pasarguard cli --help
46+
```
47+
48+
#### Admin Management
49+
50+
```bash
51+
# List all admins
52+
pasarguard cli admins --list
53+
54+
# Create new admin
55+
pasarguard cli admins --create username
56+
57+
# Delete admin
58+
pasarguard cli admins --delete username
59+
60+
# Modify admin (password and sudo access)
61+
pasarguard cli admins --modify username
62+
63+
# Reset admin usage statistics
64+
pasarguard cli admins --reset-usage username
65+
```
66+
67+
#### System Information
68+
69+
```bash
70+
# Show system status
71+
pasarguard cli system
72+
```
73+
74+
### Examples
75+
76+
**Creating a new admin:**
77+
```bash
78+
pasarguard cli admins --create john_admin
79+
# You'll be prompted to enter password and sudo permissions
80+
```
81+
82+
**Listing all admins with beautiful formatting:**
83+
```bash
84+
pasarguard cli admins --list
85+
# Displays a beautiful table with admin details
8686
```

content/docs/en/cli-tui/TUI.mdx renamed to content/docs/en/interfaces/TUI.mdx

Lines changed: 68 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,69 @@
1-
---
2-
title: TUI
3-
navigation: TUI
4-
icon: Terminal
5-
---
6-
7-
# PasarGuard TUI
8-
9-
Modern text-based user interface tools for managing PasarGuard with efficiency and style.
10-
11-
---
12-
13-
## TUI - Text User Interface
14-
15-
A modern, interactive command-line interface for managing PasarGuard, built with Textual.
16-
17-
### Features
18-
19-
- 🎯 **Interactive TUI** with mouse and keyboard support
20-
- 📱 **Responsive design** with dark mode support
21-
- ⌨️ **Keyboard shortcuts** for quick navigation
22-
- 🔄 **Real-time updates** and live data refresh
23-
- 📊 **Rich data visualization** with colors and formatting
24-
- 🔒 **Secure admin management** with visual feedback
25-
26-
### Starting the TUI
27-
28-
```bash
29-
pasarguard tui
30-
```
31-
32-
Once launched, you'll see a beautiful interactive interface with navigation panels, data tables, and action buttons.
33-
34-
### Keyboard Shortcuts
35-
36-
#### Global Commands
37-
38-
- `q` - Quit the application
39-
- `?` - Show help and keyboard shortcuts
40-
- `Tab` - Navigate between panels
41-
- `Shift+Tab` - Navigate backwards
42-
- `Escape` - Cancel current action
43-
44-
#### Admin Section
45-
46-
- `c` - Create new admin
47-
- `m` - Modify admin
48-
- `r` - Reset admin usage statistics
49-
- `d` - Delete admin
50-
- `i` - Import admins from environment variables
51-
52-
### Admin Management
53-
54-
The TUI provides a visual interface for all admin operations:
55-
56-
- **Create** - Interactive forms for new admin accounts
57-
- **Modify** - Edit admin passwords and permissions
58-
- **Delete** - Safe deletion with confirmation prompts
59-
- **Reset Usage** - Clear usage statistics for admins
60-
- **Import** - Bulk import admins from environment variables
61-
- **View Details** - Detailed admin information and status
62-
63-
### Navigation Tips
64-
65-
1. Use **arrow keys** or **mouse** to navigate
66-
2. Press **Enter** to select items or confirm actions
67-
3. Use **Tab** to move between input fields
68-
4. Press **Escape** to cancel dialogs
1+
---
2+
title: TUI
3+
navigation: TUI
4+
icon: Terminal
5+
---
6+
7+
# PasarGuard TUI
8+
9+
Text-based user interface for managing PasarGuard with efficiency and style.
10+
11+
---
12+
13+
## TUI - Text User Interface
14+
15+
A modern, interactive command-line interface for managing PasarGuard, built with Textual.
16+
17+
### Features
18+
19+
- 🎯 **Interactive TUI** with mouse and keyboard support
20+
- 📱 **Responsive design** with dark mode support
21+
- ⌨️ **Keyboard shortcuts** for quick navigation
22+
- 🔄 **Real-time updates** and live data refresh
23+
- 📊 **Visual data display** with colors and formatting
24+
- 🔒 **Secure admin management** with visual feedback
25+
26+
### Starting the TUI
27+
28+
```bash
29+
pasarguard tui
30+
```
31+
32+
After launching, you'll see a beautiful interactive interface with navigation panels, data tables, and action buttons.
33+
34+
### Keyboard Shortcuts
35+
36+
#### Global Commands
37+
38+
- `q` - Quit the application
39+
- `?` - Show help and keyboard shortcuts
40+
- `Tab` - Navigate between panels
41+
- `Shift+Tab` - Navigate backwards
42+
- `Escape` - Cancel current action
43+
44+
#### Admin Management Section
45+
46+
- `c` - Create new admin
47+
- `m` - Modify admin
48+
- `r` - Reset admin usage statistics
49+
- `d` - Delete admin
50+
- `i` - Import admins from environment variables
51+
52+
### Admin Management
53+
54+
The TUI provides a visual interface for all admin operations:
55+
56+
- **Create** - Interactive forms for new admin accounts
57+
- **Modify** - Edit admin passwords and permissions
58+
- **Delete** - Safe deletion with confirmation prompts
59+
- **Reset Usage** - Clear usage statistics for admins
60+
- **Import** - Bulk import admins from environment variables
61+
- **View Details** - Detailed admin information and status
62+
63+
### Navigation Tips
64+
65+
1. Use **arrow keys** or **mouse** to navigate
66+
2. Press **Enter** to select items or confirm actions
67+
3. Use **Tab** to move between input fields
68+
4. Press **Escape** to cancel dialogs
6969
5. Press **?** anytime to see available shortcuts

content/docs/ru/cli-tui/meta.json renamed to content/docs/en/interfaces/meta.json

File renamed without changes.

‎content/docs/en/meta.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"...introduction",
66
"panel",
77
"node",
8-
"cli-tui",
8+
"interfaces",
99
"learn",
1010
"migration"
1111
]

content/docs/fa/cli-tui/cli.mdx renamed to content/docs/fa/interfaces/cli.mdx

File renamed without changes.

content/docs/fa/cli-tui/meta.json renamed to content/docs/fa/interfaces/meta.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
{
2-
"title": "CLI و TUI",
3-
"description": "ابزارهای خط فرمان و رابط کاربری متنی",
4-
"pages": [
5-
"cli",
6-
"tui"
7-
],
8-
"icon": "Terminal"
9-
}
1+
{
2+
"title": "CLI و TUI",
3+
"description": "ابزارهای خط فرمان و رابط کاربری متنی",
4+
"pages": [
5+
"cli",
6+
"tui"
7+
],
8+
"icon": "Terminal"
9+
}

content/docs/fa/cli-tui/tui.mdx renamed to content/docs/fa/interfaces/tui.mdx

File renamed without changes.

‎content/docs/fa/meta.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"panel",
77
"node",
88
"xray",
9-
"cli-tui",
9+
"interfaces",
1010
"learn",
1111
"migration",
1212
"...faq"

content/docs/ru/cli-tui/CLI.mdx renamed to content/docs/ru/interfaces/CLI.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ icon: Terminal
1212

1313
## CLI - Интерфейс командной строки
1414

15-
Современный типобезопасный интерфейс командной строки для управления PasarGuard, созданный с помощью Typer.
15+
Современный и безопасный интерфейс командной строки для управления PasarGuard, созданный с помощью Typer.
1616

1717
### Возможности
1818

19-
- 🎯 **Типобезопасный CLI** с расширенным форматированием вывода
20-
- 📊 **Красивые таблицы и панели** для визуализации данных
19+
- 🎯 **Безопасный CLI** с красивым форматированием вывода
20+
- 📊 **Красивые таблицы и панели** для отображения данных
2121
- 🔒 **Безопасное управление администраторами** с интерактивными запросами
22-
- 📈 **Мониторинг состояния системы** и диагностика
23-
- ⌨️ **Интерактивные запросы** с подтверждениями для безопасности
22+
- 📈 **Мониторинг состояния системы** и обнаружение проблем
23+
- ⌨️ **Интерактивные запросы** с подтверждениями для повышения безопасности
2424

2525
### Установка
2626

27-
CLI включен в PasarGuard и может использоваться напрямую:
27+
CLI устанавливается вместе с PasarGuard и может использоваться напрямую:
2828

2929
```bash
3030
pasarguard cli --help
@@ -57,7 +57,7 @@ pasarguard cli admins --create username
5757
# Удалить администратора
5858
pasarguard cli admins --delete username
5959

60-
# Изменить администратора (пароль и статус sudo)
60+
# Изменить администратора (пароль и доступ sudo)
6161
pasarguard cli admins --modify username
6262

6363
# Сбросить статистику использования администратора
@@ -79,7 +79,7 @@ pasarguard cli admins --create john_admin
7979
# Вам будет предложено ввести пароль и разрешения sudo
8080
```
8181

82-
**Вывод списка всех администраторов с форматированием:**
82+
**Вывод списка всех администраторов с красивым форматированием:**
8383
```bash
8484
pasarguard cli admins --list
8585
# Отображает красивую таблицу с данными администраторов

0 commit comments

Comments
 (0)