Skip to content

Installation

Jump to bottom
Luke edited this page Nov 2, 2024 · 6 revisions

Installing Ox

To get started, please click on your operating system

Linux

Here are the list of available methods for installing on Linux:

Arch Linux

Install one of the following from the AUR:

  • ox-bin - install the pre-compiled binary (fastest)
  • ox-git - compile from source (best)

Fedora

You can find an RPM in the releases page

Install using the following command:

sudo dnf install /path/to/rpm/file

Debian

You can find a deb file in the releases page

Install using the following command:

sudo dpkg -i /path/to/deb/file

Windows

Here are the list of available methods for installing on Windows:

MacOS

Here are the list of available methods for installing on macOS:

Homebrew

Install ox from Homebrew core tap.

brew install ox

MacPorts

On macOS, you can install ox via MacPorts

sudo port selfupdate
sudo port install ox

Binaries

There are precompiled binaries available for all platforms in the releases page.

  • For Linux: download the ox executable and copy it to /usr/bin/ox, then run sudo chmod +x /usr/bin/ox
  • For MacOS: download the ox-macos executable and copy it to /usr/local/bin/ox, then run sudo chmod +x /usr/local/bin/ox
  • For Windows: download the ox.exe executable and copy it into a location in PATH see this guide for how to do it

Manual

This is the absolute best way to install Ox, it will ensure you always have the latest version and everything works for your system.

You must have a working installation of the Rust compiler to use this method. Visit the website for rustup and follow the instructions there for your operating system.

Now with a working version of rust, you can run the command:

cargo install --git https://github.com/curlpipe/ox

This will take at worst around 2 minutes. On some more modern systems, it will take around 30 seconds.

Please note that you should add .cargo/bin to your path, which is where the ox executable will live, although rustup will likely do that for you, so no need to worry too much.

Clone this wiki locally