🧑‍💻 Installation

How to install the Oxen client, server, or python package. If you are a developer, you will want to build from source. If you are flying by and learning Oxen you can install the python package or the command line tool from the GitHub releases page.

💻 Command Line Tools

The Oxen client can be installed 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 for source for your platform. The continuous integration pipeline will build binaries for each release in this repository.

Mac

brew tap Oxen-AI/oxen

brew install oxen

Ubuntu Latest

Check the GitHub releases page for the latest version of the client and server.

wget https://github.com/Oxen-AI/Oxen/releases/latest/download/oxen-ubuntu-latest.deb

sudo dpkg -i oxen-ubuntu-latest.deb

Ubuntu 20.04

wget https://github.com/Oxen-AI/Oxen/releases/latest/download/oxen-ubuntu-20.04.deb

sudo dpkg -i oxen-ubuntu-20.04.deb

Windows

wget https://github.com/Oxen-AI/Oxen/releases/latest/download/oxen.exe

Other Linux

Binaries are coming for other Linux distributions in the future. In the meanwhile, you can build 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

brew tap Oxen-AI/oxen-server

brew install oxen-server

Docker

wget https://github.com/Oxen-AI/Oxen/releases/latest/download/oxen-server-docker.tar

docker load < oxen-server-docker.tar

docker run -d -v /var/oxen/data:/var/oxen/data -p 80:3001 oxen/oxen-server:latest

Ubuntu Latest

wget https://github.com/Oxen-AI/Oxen/releases/latest/download/oxen-server-ubuntu-latest.deb

sudo dpkg -i oxen-server-ubuntu-latest.deb

Ubuntu 20.04

wget https://github.com/Oxen-AI/Oxen/releases/latest/download/oxen-server-ubuntu-20.04.deb

sudo dpkg -i oxen-server-ubuntu-20.04.deb

Windows

wget https://github.com/Oxen-AI/Oxen/releases/latest/download/oxen-server.exe

To get up and running using the client and server, you can follow the getting started docs.

🐍 Python Package

$ pip install oxenai

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:

!pip install oxenai