Skip to content

Tui

proxmox tui --help

Input:

proxmox tui --help

Output:

 Usage: proxmox tui [OPTIONS] [MODE]:[mock]                                     

 Launch interactive Proxmox TUI for resource navigation and management.         

 Opens a full-screen terminal UI for browsing Proxmox API resources             
 hierarchically and performing operations. Supports both real backends          
 (HTTPS, SSH, local) and mock mode for testing/learning.                        

 MODE:                                                                          
     - Omit or use 'mock' to connect to in-memory mock backend                  
     - Otherwise connects using configured backend credentials                  

 Key controls:                                                                  
     - Arrow keys: Navigate resources                                           
     - Enter: Drill into path or edit                                           
     - q: Quit                                                                  
     - j/k: Jump between entries                                                
     - s: Search                                                                
     - /: Filter                                                                

 Examples:                                                                      
     # Launch with configured Proxmox backend                                   
     proxmox tui                                                                

     # Launch against mock backend (no credentials needed)                      
     proxmox tui mock                                                           

     # Start at specific path                                                   
     proxmox tui -p /nodes/pve1/qemu                                            

     # For PMG/PBS:                                                             
     pbx tui          # Proxmox Mail Gateway                                    
     pbs tui          # Proxmox Backup Server                                   

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│   mode      [MODE]:[mock]  Optional mode. Use 'mock' to run TUI against      │
│                            in-memory mock backend.                           │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --path  -p      TEXT  Initial API path to load in the TUI. [default: /nodes] │
│ --help                Show this message and exit.                            │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.219