Add cross-platform CLI Installers

.github/workflows/check-installers.yml

@@ -0,0 +1,88 @@
+name: Check CLI installers
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "utils/installers/**"
+      - ".github/workflows/check-installers.yml"
+  pull_request:
+    paths:
+      - "utils/installers/**"
+      - ".github/workflows/check-installers.yml"
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+
+jobs:
+  linux-installer:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Run installer
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          HF_TEST_ROOT=$(mktemp -d)
+          INSTALL_DIR="$HF_TEST_ROOT/install"
+          BIN_DIR="$HF_TEST_ROOT/bin"
+
+          HF_HOME="$INSTALL_DIR" HF_CLI_BIN_DIR="$BIN_DIR" utils/installers/install.sh --no-modify-path
+
+          export PATH="$BIN_DIR:$PATH"
+
+          HF_VERSION_PATH="$HF_TEST_ROOT/hf-version.txt"
+          hf version | tee "$HF_VERSION_PATH"
+          if ! grep -Eq 'huggingface_hub version: [0-9]+(\.[0-9]+){1,2}' "$HF_VERSION_PATH"; then
+            echo "hf version output missing huggingface_hub version" >&2
+            cat "$HF_VERSION_PATH" >&2
+            exit 1
+          fi
+
+          NO_COLOR=1 hf --help
+
+          rm -rf "$HF_TEST_ROOT"
+
+  windows-installer:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Run installer 
+        shell: pwsh
+        run: |
+          $hfTestRoot = Join-Path $env:TEMP ([System.Guid]::NewGuid().ToString())
+          $installDir = Join-Path $hfTestRoot 'install'
+          $binDir = Join-Path $hfTestRoot 'bin'
+          New-Item -ItemType Directory -Path $installDir -Force | Out-Null
+          New-Item -ItemType Directory -Path $binDir -Force | Out-Null
+
+          $env:HF_HOME = $installDir
+          $env:HF_CLI_BIN_DIR = $binDir
+          & "$PWD/utils/installers/install.ps1" -NoModifyPath
+
+          $env:PATH = "$binDir;$env:PATH"
+
+          $hfVersionPath = Join-Path $hfTestRoot 'hf-version.txt'
+          & hf.exe version | Tee-Object -FilePath $hfVersionPath
+          if ($LASTEXITCODE -ne 0) {
+            throw 'hf version failed'
+          }
+          if (-not (Select-String -Path $hfVersionPath -Pattern 'huggingface_hub version: [0-9]+(\.[0-9]+){1,2}')) {
+            throw 'hf version output missing huggingface_hub version'
+          }
+
+          $env:NO_COLOR = '1'
+          & hf.exe --help
+          if ($LASTEXITCODE -ne 0) {
+            throw 'hf --help failed'
+          }
+          Remove-Item Env:NO_COLOR
+
+          Remove-Item -Path $hfTestRoot -Recurse -Force

docs/source/en/guides/cli.md

@@ -17,6 +17,20 @@ First of all, let's install the CLI:
 > [!TIP]
 > In the snippet above, we also installed the `[cli]` extra dependencies to make the user experience better, especially when using the `cache delete` command.
 
+Alternatively, you can install the `hf` CLI with a single command:
+
+On macOS and Linux:
+
+```bash
+>>> curl -LsSf https://hf.co/install.sh | sh
+```
+
+On Windows:
+
+```powershell
+>>> powershell -c "irm https://hf.co/install.ps1 | iex"
+```
+
 Once installed, you can check that the CLI is correctly setup:
 
 ```

docs/source/en/installation.md

@@ -103,6 +103,22 @@ Python will now look inside the folder you cloned to in addition to the normal l
 For example, if your Python packages are typically installed in `./.venv/lib/python3.13/site-packages/`,
 Python will also search the folder you cloned `./huggingface_hub/`.
 
+## Install the Hugging Face CLI 
+
+Use our one-liner installers to set up the `hf` CLI without touching your Python environment:
+
+On macOS and Linux:
+
+```bash
+curl -LsSf https://hf.co/install.sh | sh
+```
+
+On Windows:
+
+```powershell
+powershell -c "irm https://hf.co/install.ps1 | iex"
+```
+
 ## Install with conda
 
 If you are more familiar with it, you can install `huggingface_hub` using the [conda-forge channel](https://anaconda.org/conda-forge/huggingface_hub):