Skip to main content

Terminal

The Terminal page embeds a full interactive command-line session right inside the dashboard.

Terminal page
Terminal page

Browser-Based CLI

Open the Terminal from the dashboard sidebar and get an interactive px> prompt. Type commands, see output, and navigate — just like SSH, but in your browser.

info

The Terminal requires a WebSocket connection. Make sure your browser and network allow WebSocket traffic to the device.

Command Discovery

Type help or list at the prompt to see all available commands, including:

  • Command description
  • Accepted parameters
  • Backend type (D-Bus, REST, or internal)

Built-In Commands

In addition to system commands, the shell supports the following built-in commands:

CommandDescription
helpDisplay help information for available commands
listList all registered commands with descriptions
clearClear the terminal screen
exitClose the terminal session

Real-Time I/O

Keystrokes are sent to the server over WebSocket, and output streams back to the terminal in real time. There is no polling and no page refreshes — everything happens live.

tip

If the terminal appears unresponsive, check that the WebSocket connection is active. A network interruption will break the session; refresh the page to reconnect.

Auto-Resize

The terminal adapts to your browser window size. Resizing your browser will automatically reflow the terminal content.

Best Practices

  1. Use help or list to discover available commands before running unfamiliar ones
  2. Keep the Terminal tab open during troubleshooting for real-time feedback
  3. Avoid running destructive commands unless you understand their impact
  4. Reconnect after network changes by refreshing the page if the session drops