Skip to main content

Installation

XetHub provides a hosted web UI alongside Python and Git tools for interacting with repositories. Installation of these tools is required for Xet repository operations to function properly.

If you've already installed and logged in via our Quickstart, go ahead and skip to the next section.


Create a XetHub account

A XetHub account is required for pushing any changes to a Xet repository or accessing private repositories.

If you haven't already, create an account using one of these options from the web UI:

  • Sign In With GitHub/GitLab (recommended) associates existing credentials with a new XetHub account.
  • Register creates a new XetHub account associated with your email address.

Install XetHub tools

Git-Xet and PyXet offer intuitive interfaces for accessing, updating, and tracking your repositories.

Git-Xet installation

The git-xet Git extension allows users to interface with Xet repositories as they would any normal Git repository.

note

Git-Xet requires Git v2.29 or above and a configured Git identity to avoid unexpected errors.

  1. Download and run the MacOS pkg installer.

PyXet installation

PyXet is a Python package that provides a lightweight interface to XetHub with familiar file system operations and integrations with common tools. Included with PyXet installation is support for PyXet CLI, which allows users to run commands from their terminal.

  1. Using a supported version of Python (3.7+), set up your virtualenv with:

    python -m venv .venv
    source .venv/bin/activate
  2. Install PyXet with:

    pip install pyxet

Configure authentication

Choose between our Personal Access Token and SSH authentication methods.

We've implemented HTTPS authentication in the form of Personal Access Tokens. This is the recommended way to configure your client to interact with our servers in a secure way.
  1. Navigate to the Personal Access Token setup page.
  2. Click Create Token
  3. Login with xet login from your terminal.
    xet login -e <email> -u <username> -p <personal_access_token>