Skip to main content

oxen.clone

clone

Clone a repository Arguments:
  • repo_id - str Name of the repository in the format β€˜namespace/repo_name’. For example β€˜ox/chatbot’
  • path - Optional[str] The path to clone the repo to. Defaults to the name of the repository.
  • host - str The host to connect to. Defaults to β€˜hub.oxen.ai’
  • branch - str The branch name id to clone. Defaults to β€˜main’
  • scheme - str The scheme to use. Defaults to β€˜https’
  • all - bool Whether to clone the full commit history or not. Default: False
  • filters - str | list[str] | None Filter down the set of directories you want to clone. Useful if you have a large repository and only want to make changes to a specific subset of files. Default: None
Returns: Repo A Repo object that can be used to interact with the cloned repo.