Installation

XetHub is comprised of a web UI and a git-xet extension. A XetHub account, installation of the git-xet extension, and set SSH keys are required for most Xet repository operations to function properly.

caution

XetHub requires Git v2.29 or above and a configured Git identity:

• Don't have Git? Install it now.
• Confirm that your Git username and email are set.

Old Git versions and unset profiles may cause unexpected errors.

Install the git-xet extension

The git-xet Git command line extension adds support for Xet mount and XetHub storage.

MacOS pkg (Recommended)

1. Download and run the MacOS pkg installer.
2. From your terminal, initialize the extension with:

   git xet install

MacOS Homebrew

1. From your terminal, install the git-xet extension using Homebrew:

   brew tap xetdata/xet-tools
   brew install xet-tools
2. Initialize the extension with:

   git xet install

Linux

1. Download and unzip the compressed binary.

   curl -o https://github.com/xetdata/xet-tools/releases/download/v0.8.1/xet-v0.8.1-linux-x86_64.tar.gz
   tar -xvf xet-v0.8.1-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.

   export PATH=$PWD:$PATH

3. Install the extension with:

   git xet install

Windows (Preview)

note

Windows support is in preview mode with the 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. Install the Microsoft C and C++ runtime libraries.

2. Intend to use mount functionality? If so, take these steps to install the Windows Client for NFS, which is required to use git xet mount. Mounting is currently only supported for Windows Pro, Enterprise, and Server.

   • On Pro and Enterprise editions, in a PowerShell prompt with Administrator permissions, run:

     Enable-WindowsOptionalFeature -FeatureName ServicesForNFS-ClientOnly, ClientForNFS-Infrastructure -Online -NoRestart
   • On Server editions of Windows, in a PowerShell prompt with Administrator permissions, run:

     Install-WindowsFeature NFS-Client

3. 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!

Confirm install

Verify installation by printing out the version:

git xet -V

gitxet 0.8.1

Create a XetHub account

A XetHub account is required for pushing any changes to a Xet repository.

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, requiring email confirmation.

Set your SSH key

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