Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/pythops/oryx/llms.txt

Use this file to discover all available pages before exploring further.

Once Oryx starts sniffing, the terminal is divided into two main areas: a settings bar at the top showing the active interface and applied filters, and a tabbed section panel below where you interact with captured data. A context-sensitive footer at the bottom of the panel displays the keybindings available for the current section.

Sections

The section panel contains five tabs, each focused on a different aspect of network monitoring. The active section is highlighted in the header. Press Tab or Shift+Tab to cycle through them.
SectionDescription
InspectionLive scrollable list of captured packets. Supports fuzzy search and per-packet detail view.
StatsComprehensive traffic statistics for the active interface, broken down by protocol.
MetricsCustom metric explorers you define to track specific traffic patterns over time.
AlertsAutomatic threat detection — displays a warning when a SYN flood attack pattern is detected in ingress traffic.
FirewallManage eBPF-backed firewall rules to block ingress or egress traffic in real time.
1

Move forward through sections

Press Tab to advance from Inspection → Stats → Metrics → Alerts → Firewall → Inspection.
2

Move backward through sections

Press Shift+Tab to cycle in reverse order.

Scrolling within a section

Use j or the Down arrow to scroll down through the current section’s list. Use k or the Up arrow to scroll up.

Popups and modes

Several actions open overlay popups — for example, viewing packet details, editing a firewall rule, or updating filters. Press Esc to dismiss any open popup or exit the current mode without applying changes.

Quitting and resetting

  • q or Ctrl+C — quit Oryx and terminate all eBPF packet capture threads.
  • Ctrl+R — reset the app, clearing all captured packets and restarting capture with the current filters.
Resetting with Ctrl+R restarts capture from scratch. All packets accumulated in the current session are discarded.

Build docs developers (and LLMs) love