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.

You can run Oryx with no arguments and configure everything interactively, or pass flags to pre-select the interface and filters before the TUI opens. When --interface is provided, Oryx skips the setup screen and starts capturing immediately.
sudo oryx [OPTIONS]

Flag reference

FlagShortValuesDefaultDescription
--interface-iany valid interface nameNetwork interface to capture on. Must be a name reported by the system (e.g. eth0, wlan0).
--transport-ttcp, udp, sctp, allallTransport-layer protocols to capture. Comma-separated.
--network-nipv4, ipv6, icmpv4, icmpv6, igmp, allallNetwork-layer protocols to capture. Comma-separated.
--link-larp, allallLink-layer protocols to capture. Comma-separated.
--direction-dingress, egress, allallTraffic direction to capture. Comma-separated.
All protocol flags accept all as a shorthand for enabling every supported value within that layer. Passing all alongside other values is equivalent to passing all alone.

Usage examples

Start with no arguments and configure everything from the interactive setup screen:
sudo oryx
Capture all traffic on eth0:
sudo oryx --interface eth0
Capture only TCP and UDP traffic on wlan0:
sudo oryx -i wlan0 --transport tcp,udp
Capture only ingress IPv4 and IPv6 traffic on eth0:
sudo oryx -i eth0 --network ipv4,ipv6 --direction ingress
Capture ARP traffic only:
sudo oryx -i eth0 --transport all --network all --link arp

Checking available interfaces

Oryx validates the value of --interface against the interfaces present on your system at startup. If you pass an unknown name, Oryx prints the list of valid interfaces and exits. To list available interfaces before starting Oryx, use ip link:
ip link show
All filter flags set at startup pre-populate the interactive filter panel. You can adjust them at any time while Oryx is running by pressing f.

Build docs developers (and LLMs) love