Skip to content

Commit cabe979

Browse files
committed
addressing PR feedback
1 parent 551e10b commit cabe979

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

docs/hub/xet/using-xet-storage.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,16 @@ Install [Git](https://git-scm.com/) and [Git LFS](https://git-lfs.com/).
3636

3737
### Install on macOS or Linux (amd64 or aarch64)
3838

39-
To install using [Homebrew](https://brew.sh/):
39+
Install using an installation script with the following command in your terminal (requires `curl` and `unzip`):
4040
```
41-
brew tap huggingface/tap
42-
brew install git-xet
41+
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/huggingface/xet-core/refs/heads/main/git_xet/install.sh | sh
4342
```
44-
Or, using an installation script, run the following in your terminal (requires `curl` and `unzip`):
43+
Or, install using [Homebrew](https://brew.sh/), with the following [tap](https://docs.brew.sh/Taps) (direct `brew install` coming soon):
4544
```
46-
curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/huggingface/xet-core/refs/heads/main/git_xet/install.sh | sh
45+
brew tap huggingface/tap
46+
brew install git-xet
4747
```
48+
4849
To verify the installation, run:
4950
```
5051
git-xet --version
@@ -65,6 +66,23 @@ To verity the installation, run:
6566
git-xet --version
6667
```
6768

69+
### Using Git Xet
70+
71+
Once installed on your platform, using Git Xet is as simple as following the Hub's standard Git workflows. First, make sure Git LFS is initialized in your local version of the repository:
72+
73+
```
74+
git lfs install
75+
```
76+
Then make any additions you might want, commit your changes, and `push` your commit to the Hub:
77+
78+
```
79+
# Create any files you like! Then...
80+
git add .
81+
git commit -m "Uploading new models" # You can choose any descriptive message
82+
git push
83+
```
84+
Under the hood, the [Xet protocol](https://huggingface.co/docs/xet/index) is invoked to upload large files directly to Xet storage, increasing upload speeds through the power of [chunk-level deduplication](./deduplication).
85+
6886
### Uninstall on macOS or Linux
6987

7088
Using Homebrew:

0 commit comments

Comments
 (0)