|
| 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 |
| 69 | +5. Press **?** anytime to see available shortcuts |
0 commit comments