For a detailed guide to get up and running with Python, see Getting Started.

​
Clone

clone is used to download a repository to your local machine.

​
Initialize Repository

init is used to initialize a new local repository.

​
Configure User

user is used to configure the user for a local repository.

​
Setup Auth

auth is used to configure authentication for remote repositories.

​
Repositories

The Repositories page has an overview of the two repository classes, and detailed documentation for each class can be found on their respective pages below.

​
Local Repository

Repo is used to interact with data locally.

​
Remote Repository

RemoteRepo is used to interact with a remote data without downloading all of it locally.

​
OxenFS

OxenFS is an fsspec backend that allows you to read and write files in your Oxen repo through a Pythonic file interface. It also provides a convenient integration point with third-party libraries.