diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..c066302 --- /dev/null +++ b/Readme.md @@ -0,0 +1,84 @@ +
+

TUI for sniffing network traffic using eBPF

+
+ +## 📸 Demo + +## ✨ Features + +- Real-time traffic inspection and visualization. +- Comprehensive Traffic Statistics. +- Fuzzy search. + +## 💡 Prerequisites + +A Linux based OS. + +> [!NOTE] +> You might need to install [nerdfonts](https://www.nerdfonts.com/) for the icons to be displayed correctly. + +## 🚀 Installation + +### 📥 Binary release + +You can download the pre-built binaries from the release page [release page](https://github.com/pythops/oryx/releases) + +### ⚒️ Build from source + +To build `oryx`: + +1. Install Rust nightly toolchain + +``` +rustup toolchain install nightly --component rust-src +``` + +2. Install [bpf-linker](https://github.com/aya-rs/bpf-linker) + +``` +cargo install bpf-linker +``` + +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 +``` + +## ⌨️ Key Bindings + +`?`: Show help. + +`Tab` or `Shift + Tab`: Switch between different sections. + +`j` or `Down` : Scroll down. + +`k` or `Up`: Scroll up. + +`esc`: Dismiss the different pop-ups and modes. + +`q` or `ctrl + c`: Quit the app. + +`Space`: Select/Deselect interface or filter. + +`f`: Update the applied filters. + +`ctrl + r`: Reset the app. + +`ctrl + s`: Export the capture to `~/oryx/capture` file. + +`/`: Start fuzzy finding. + +## ⚖️ License + +GPLv3