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.

MacOS pkg (Recommended)

1. Download and run the MacOS pkg installer.

Linux

Ubuntu/Debian-based

1. Download the deb archive.

   wget https://github.com/xetdata/xet-tools/releases/latest/download/xet-linux-x86_64.deb

2. Install the deb archive with:

   sudo apt install ./xet-linux-x86_64.deb
3. Install the extension with:

   git xet install

All Other Distributions

1. Download and unzip the compressed binary.

   wget https://github.com/xetdata/xet-tools/releases/latest/download/xet-linux-x86_64.tar.gz
   tar -xvf xet-linux-x86_64.tar.gz

2. Move git-xet to your preferred location and add it to your PATH so that Git can access it.

   sudo cp git-xet /usr/local/bin
3. Install the extension with:

   git xet install

Windows

note

Windows support has some known limitations. Please file any issues you encounter!

Advanced usage: For scripted installations, place our standalone Windows Git-Xet binary anywhere in your PATH.

1. Download and run the Windows Installer.

note

Using Microsoft Edge? Your browser may block a full download of the installer and show an Unconfirmed .crdownload file in the Downloads folder.

To fix this, go to the Downloads icon in Microsoft Edge and hover over the caution message to display the Trash and More options. Click the three dots for more options and choose "Keep". This may trigger the following warning.

Click "Show More" to expand the options and click "Keep anyway". At this point, the .crdownload will turn into the real git-xet-windows-installer executable. If you have the time, we'd also appreciate if you can also "Report this app as safe" to help make it easier for everyone to access the 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.

Personal Access Token (Recommended)

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>

SSH

Standard Git SSH authentication is also supported. If you are familiar with and comfortable with configuring SSH keys, you may want to use this method instead.

To encrypt all communications, generate a SSH keypair and add the public key to your XetHub account.