Skip to main content

​
Command Line Tools

The Oxen client can be installed on MacOS via homebrew or by downloading the relevant binaries for Linux or Windows. You can find the source code for the client here and can also build from source for your platform. All binaries for MacOS, Linux, Windows and Docker are available on GitHub Releases.

​
Mac

​
Linux

​
Ubuntu

We provide .deb packages that can be installed directly on Debian-based systems such as Ubuntu. First, download the release for your system’s architecture. For x86-64
For ARM64
Then run

​
Other distributions

We also provide distributions-agnostic binaries that can be installed on any Linux system. First, download the release for your system’s architecture. For x86-64
For ARM64

​
Windows

We provide Windows binaries as a .exe.

​
Python Package

The easiest way to get started with the Oxen Python library is to use uv. Install uv. Install a supported Python version
Then, create and init a new uv project.
This will create a virtual environment with the latest installed Python version. Next, add the oxen library to the project
Then, to test that everything is working, update main.py with the following code.
Then run the script with uv run so it executes in the virtual environment.
Note that this will only install the Python library and not the command line tool.

​
Installing Oxen through Jupyter Notebooks or Google Colab

Create and run this cell:

​
Docker

We build many binary wheels for the Python library (and we’re working on adding more), but if your container image doesn’t work with one of our binary wheels, pip will have to build it from source. Here is a minimal Dockerfile for a Debian-based image that installs the prerequisites for building the Oxen library from source:

​
Server Install

The Oxen server binary can be deployed where ever you want to store and backup your data. It is an HTTP server that the client communicates with to enable collaboration.

​
Mac

​
Docker

First, download the Docker image based on the host architecture. For x86-64
For ARM64
Then, load the image into Docker.
Finally, run a new container.

​
Linux

​
Ubuntu

We provide .deb packages that can be installed directly on Debian-based systems such as Ubuntu. First, download the release for your system’s architecture. For x86-64
For ARM64
Then run

​
Other distributions

First, download the release for your system’s architecture. For x86-64
For ARM64

​
Windows

oxen-server is not supported on Windows. Host the server on Linux, macOS, or Docker (see the sections above). The Windows oxen CLI and the Python package still work as clients against a server running on a supported platform.
To get up and running using the client and server, you can follow the getting started docs.

​
Building from Source

To build the command line tool from source, you can follow these steps.
  1. Install rustup via the instructions at https://rustup.rs/
  2. Clone the repository https://github.com/Oxen-AI/Oxen
  3. cd into the cloned repository
  4. Run this command (the release flag is recommended but not necessary):
  5. After the build has finished, the oxen binary will be in Oxen/oxen-rust/target/release (or, if you did not use the —release flag, Oxen/oxen-rust/target/debug). Now, to make it usable from a terminal window, you have the option to add it to create a symlink or to add it to your PATH.
  6. To add oxen to your PATH: Add this line to your .bashrc (or equivalent, e.g. .zshrc)
  7. Alternatively, to create a symlink, run the following command:
    Note that if you did not use the --release flag when building Oxen, you will have to change the path.