Most Oxen workflows begin in one of three ways: initializing a fresh local repository, cloning an existing one from a remote, or pulling down specific files without setting up a full repo.Documentation Index
Fetch the complete documentation index at: https://docs.oxen.ai/llms.txt
Use this file to discover all available pages before exploring further.
Initialize a Local Repository
Create a new Oxen repository in the current directory withoxen init.
.oxen/ directory in your working directory containing the repository metadata. As you add and commit files, each commit’s Merkle Tree is stored under .oxen/.
Clone a Remote Repository
There are a few ways to clone an Oxen repository, depending on how much data you want to transfer. The defaultoxen clone with no flags downloads the latest commit from the main branch.
CatDogBBox containing the files from the latest commit, plus a .oxen/ folder with the Merkle Tree for the branch’s history.
Clone a Specific Branch
Use the-b flag to clone from a branch other than main.
Clone All Branches
To clone the commit history for every branch (useful when migrating a repo to a new remote), use--all.
Clone a Subtree
If you only need a subset of the repository, use--filter and --depth to limit the clone. --filter selects which directories to clone, while --depth limits how many levels of subdirectories are recursed into.
annotations directory, without recursing into any new subdirectories.
Remote Mode
If the repository is larger than you can store locally, you can clone it in remote mode to download the commit Merkle trees without the file contents.oxen restore.
Configure a Remote
If you initialized a repository locally, you can point it at a remote withoxen config --set-remote. This is what enables oxen push, oxen pull, and oxen fetch.
origin) and the URL of the remote repository. Cloned repositories already have origin set automatically.
A repo can have multiple remotes — most commands default to origin if no remote is specified.
Create a Remote from the CLI
If the remote repository doesn’t exist yet, you can create it from the CLI withoxen create-remote.
Download Specific Files
If you only need specific files or directories — without cloning the whole repository — useoxen download.
--revision.