xet-core

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

Files

Assaf Vayner d40f96bbea Fix spelling typos in comments and docs (#826 )

## Summary
- Run codespell across tracked files in the repo and fix unambiguous
spelling typos
- All edits are in comments, doc strings, an issue template, and one log
message — no logic changes
- 22 typos fixed across 19 files (e.g. retreived→retrieved,
elegible→eligible, occurances→occurrences, gauranteed→guaranteed,
endianess→endianness, archetectures→architectures, etc.)

## Cases left for follow-up (not in this PR)
A few hits were ambiguous and need human judgment:
- \`xet_core_structures/src/metadata_shard/shard_file_manager.rs:1400\`
— comment "but delet" appears truncated
- \`xet_core_structures/src/metadata_shard/shard_format.rs:1577\` —
"invalid somes" likely meant "invalid ones"
- \`xet_data/src/deduplication/chunking.rs:564\` — comment trails off
("on other po")

False positives left untouched: \`serde::ser::*\` module paths,
"process-global statics" (Rust \`static\` items), "implementor(s)"
(valid alternate of "implementer"), "re-used", "unparseable".

## Test plan
- [x] \`cargo check --workspace --lib --all-features\` passes
- [ ] CI green on the draft PR

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Low Risk**
> Low risk: changes are limited to spelling fixes in comments/docs, an
issue template string, and a single log message, with no functional code
modifications.
> 
> **Overview**
> Fixes a set of unambiguous spelling typos across the repo (primarily
Rust comments/docstrings plus `.github/ISSUE_TEMPLATE/bug-report.yml`
and `api_changes/README.md`).
> 
> Also corrects one user-facing log line in `hf_xet` ("cofigured" ->
"configured"); otherwise behavior is unchanged.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
e615df87a8. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

2026-04-30 13:15:18 -07:00

src

Fix spelling typos in comments and docs (#826 )

2026-04-30 13:15:18 -07:00

tests

Move test-only deps to dev-dependencies in git_xet (#767 )

2026-03-31 13:31:20 -07:00

windows_installer

Upgrade git-xet to 0.2.1 (#653 )

2026-02-12 15:45:34 -08:00

Cargo.toml

Move test-only deps to dev-dependencies in git_xet (#767 )

2026-03-31 13:31:20 -07:00

entitlements.xml

Build and release git-xet (#499 )

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

install.sh

Update git-xet install URls (#655 )

2026-02-12 16:40:40 -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.