xet-core

mirror of https://github.com/huggingface/xet-core.git synced 2026-06-04 13:30:29 +08:00

Files

Hoyt Koepke 396e11745c Unix Socket Proxy support. (#618 )

This PR updates https://github.com/huggingface/xet-core/pull/598, which
adds Unix domain socket support for the RemoteClient interface. This
version adds extensive testing using the LocalTestServer interface and
creating a local proxy for it.

Use the environment variable
HF_XET_CLIENT_UNIX_SOCKET_PATH=/path/to/socket to route all traffic
through a Unix socket. This is useful when running a XET client in a
sandbox that doesn't have direct access to the network or for using
tools like noxious_client to simulate bad network conditions.

---------

Co-authored-by: Frank Denis <github@pureftpd.org>

2026-01-28 12:27:41 -10:00

src

Unix Socket Proxy support. (#618 )

2026-01-28 12:27:41 -10:00

tests

Integration test for ssh access on Windows (#566 )

2025-11-20 03:22:19 -08:00

windows_installer

Update git-xet Windows installer package version (#576 )

2025-11-21 12:56:27 -08:00

Cargo.toml

Unix Socket Proxy support. (#618 )

2026-01-28 12:27:41 -10:00

entitlements.xml

Build and release git-xet (#499 )

2025-09-22 15:44:02 -07:00

install.sh

Fold "git lfs install" into "git xet install" (#613 )

2026-01-23 11:05:52 -08:00

README.md

Update git-xet install instructions (#583 )

2025-12-02 16:04:20 -08:00

README.md

Git-Xet is a Git LFS custom transfer agent that implements upload and download of files using the Xet protocol. Install git-xet, follow your regular workflow to git lfs track ... & git add ... & git commit ... & git push, and your files are uploaded to Hugging Face repos using the Xet protocol. Enjoy the dedupe!

Installation

Prerequisite

Make sure you have git and git-lfs installed and configured correctly.

macOS or Linux (amd64 or aarch64)

To install using Homebrew:

brew install git-xet
git xet install

Or, using an installation script, run the following in your terminal (requires curl and unzip):

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/huggingface/xet-core/refs/heads/main/git_xet/install.sh | sh

To verify the installation, run:

git xet --version

Windows (amd64)

Using winget:

winget install git-xet

Using an installer:

Download git-xet-windows-installer-x86_64.zip (available here) and unzip.
Run the msi installer file and follow the prompts.

Manual installation:

Download git-xet-windows-x86_64.zip (available here) and unzip.
Place the extracted git-xet.exe under a PATH directory.
Run git-xet install in a terminal.

To verify the installation, run:

git xet --version

Uninstall

macOS or Linux

Using Homebrew:

git xet uninstall
brew uninstall git-xet

If you used the installation script (for MacOS or Linux), run the following in your terminal:

git xet uninstall
sudo rm $(which git-xet)

Windows

If you used winget:

winget uninstall git-xet

If you used the installer:

Navigate to Settings -> Apps -> Installed apps
Find "Git-Xet".
Select the "Uninstall" option available in the context menu.

If you manually installed:

Run git xet uninstall in a terminal.
Delete the git-xet.exe file from the location where it was originally placed.

How It Works

Git-Xet works by registering itself as a custom transfer agent to Git LFS by name "xet". On git push, git fetch or git pull, git-lfs negotiates with the remote server to determine the transfer agent to use. During this process, git-lfs sends to the server all locally registered agent names in the Batch API request, and the server replies with exactly one agent name in the response. Should "xet" be picked, git-lfs delegates the uploading or downloading operation to git-xet through a sequential protocol.

For more details, see the Git LFS Batch API and Custom Transfer Agent documentation.