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.

Oryx runs on Linux only. You can install it in three ways: download a pre-built binary from the releases page, install the package from the Arch Linux extra repository, or build it from source using the Rust nightly toolchain.

Prerequisites

Before installing, make sure your system meets these requirements:
  • Linux kernel 6.10 or higher — required for full eBPF feature support.
  • Nerd Fonts — required for icons in the TUI to render correctly.
If you’re on Debian or Ubuntu, you need at minimum:
  • Debian 13 (Trixie) or newer
  • Ubuntu 24.04 (Noble) or newer

Installation methods

Download a pre-built binary from the releases page and place it in your $PATH.
1

Download the binary

Go to the Oryx releases page and download the binary for your architecture.
2

Make the binary executable

chmod +x oryx
3

Move it into your PATH

sudo mv oryx /usr/local/bin/oryx
4

Verify the installation

oryx --version

Build docs developers (and LLMs) love