How to install the Oxen client, server, or python package.
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.
Check the GitHub releases page for the latest version of the client and server.
Note that this will only install the Python library and not the command line tool.
Create and run this cell:
Binaries are coming for other Linux distributions in the future. In the meanwhile, you can build from source.
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:
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.
To get up and running using the client and server, you can follow the getting started docs.
To build the command line tool from source, you can follow these steps.
Install rustup via the instructions at https://rustup.rs/
Clone the repository https://github.com/Oxen-AI/Oxen
cd
into the cloned repository
Run this command (the release flag is recommended but not necessary):
After the build has finished, the oxen
binary will be in Oxen/target/release
(or, if you did not use the —release flag, Oxen/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
.
To add oxen to your PATH
:
Add this line to your .bashrc
(or equivalent, e.g. .zshrc
)
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.
How to install the Oxen client, server, or python package.
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.
Check the GitHub releases page for the latest version of the client and server.
Note that this will only install the Python library and not the command line tool.
Create and run this cell:
Binaries are coming for other Linux distributions in the future. In the meanwhile, you can build from source.
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:
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.
To get up and running using the client and server, you can follow the getting started docs.
To build the command line tool from source, you can follow these steps.
Install rustup via the instructions at https://rustup.rs/
Clone the repository https://github.com/Oxen-AI/Oxen
cd
into the cloned repository
Run this command (the release flag is recommended but not necessary):
After the build has finished, the oxen
binary will be in Oxen/target/release
(or, if you did not use the —release flag, Oxen/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
.
To add oxen to your PATH
:
Add this line to your .bashrc
(or equivalent, e.g. .zshrc
)
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.