Skip to content

Readme.md

Latest commit

 

History

History
111 lines (69 loc) · 2.27 KB

Readme.md

File metadata and controls

111 lines (69 loc) · 2.27 KB
Raw

TUI for sniffing network traffic using eBPF

📸 Demo

✨ Features

  • Real-time traffic inspection and visualization.
  • Comprehensive Traffic Statistics.
  • Firewall functionalities.
  • Metrics explorer.
  • Fuzzy search.

🚀 Supported protocols

Transport Layer

  • TCP
  • UDP
  • SCTP

Network Layer

  • IP (v4, v6)
  • ICMP (v4, v6)
  • IGMP (v1, v2, v3)

Link Layer

  • ARP

💡 Prerequisites

A Linux based OS.

Ideally with Linux kernel version 6.10 or higher to ensure all the features to work properly.

Note

If you're using Debian or Ubuntu, ensure you're on the following minimum versions:

  • Debian: Version 13 (Trixie) or newer
  • Ubuntu: Version 24.04 (Noble) or newer

Fonts

You might need to install nerdfonts for the icons to be displayed correctly.

🚀 Installation

📥 Binary release

You can download the pre-built binaries from the release page release page

🐧Arch Linux

You can install oryx from the extra repository with using pacman:

pacman -S oryx

⚒️ Build from source

To build oryx:

1. Install Rust nightly toolchain

rustup toolchain install nightly --component rust-src

2. Install bpf-linker

Check bpf-linker Installation section .

3. Build

cargo xtask build --release

This will produce an executable file at target/release/oryx that you can copy to a directory in your $PATH.

🪄 Usage

Run the following command to start oryx:

sudo oryx

Note

You can start oryx with args as well. Check oryx --help to see the available options

🤝 Contributing

  • Strict No LLM.
  • Only submit a PR after having a prior issue or discussion.
  • Keep PRs small and focused.

✍️ Credits

Logo designed by @ling0x

⚖️ License

GPLv3