Install Git-Xet

If you've already installed and logged in via our Install Guide, go ahead and skip to our hands-on example.

Already working with GitHub for your code? Try out XetData, a GitHub application that adds lightweight Xet support to existing GitHub repositories.

---

The Git-Xet client adds natural support for managing large files to Git. Once installed, XetHub will manage all files in the repository, storing all binary files and files over 256KB on XetHub servers to take advantage of our efficient storage structure. Once installed, all normal Git commands (e.g., clone, commit) will work as expected without any extra commands or storage setup.

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 the compressed binary and unzip it.

   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!

Installing Git-Xet as part of our XetData GitHub integration? You're good to go. Continue your setup in GitHub!

Here for XetHub? Click Next to continue your onboarding.