Rename CLI to 'hf' + reorganize syntax (#3229)

* Rename CLI to 'hf' + reorganize them

* fix  test_command_delete_cache.py

* fix tests/test_utils_cache.py

* Update src/huggingface_hub/cli/__init__.py

Co-authored-by: Lysandre Debut <hi@lysand.re>

* Document hf instead of huggingface-cli everywhere

* Remove deprecated options

* fix tests

---------

Co-authored-by: Lysandre Debut <hi@lysand.re>

Author: Wauplin

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -33,7 +33,7 @@ body:
       description: |
         Please dump your environment info by running the following command and copy-paste the result here:
         ```txt
-        huggingface-cli env
+        hf env
         ```
 
         If you are working in a notebook, please run it in a code cell:

CONTRIBUTING.md

@@ -59,7 +59,7 @@ Did not find it? :( So we can act quickly on it, please follow these steps:
 
 - A short, self-contained, code snippet that allows us to reproduce the bug in less than 30s;
 - Provide the _full_ traceback if an exception is raised by copying the text from your terminal in the issue description.
-- Include information about your local setup. You can dump this information by running `huggingface-cli env` in your terminal;
+- Include information about your local setup. You can dump this information by running `hf env` in your terminal;
 
 ### Do you want a new feature?
 

README.md

@@ -97,9 +97,9 @@ Files will be downloaded in a local cache folder. More details in [this guide](h
 The Hugging Face Hub uses tokens to authenticate applications (see [docs](https://huggingface.co/docs/hub/security-tokens)). To log in your machine, run the following CLI:
 
 ```bash
-huggingface-cli login
+hf auth login
 # or using an environment variable
-huggingface-cli login --token $HUGGINGFACE_TOKEN
+hf auth login --token $HUGGINGFACE_TOKEN
 ```
 
 ### Create a repository

docs/source/cn/quick-start.md

@@ -49,9 +49,9 @@ filename: 要下载的文件名，这里是 "config.json"
 运行以下代码，这将使用您的用户访问令牌登录到Hugging Face模型库
 
 ```bash
-huggingface-cli login
+hf auth login
 
-huggingface-cli login --token $HUGGINGFACE_TOKEN
+hf auth login --token $HUGGINGFACE_TOKEN
 ```
 
 或者，你可以在笔记本电脑或脚本中使用 [`login`] 来进行程序化登录,请运行以下代码:
@@ -63,7 +63,7 @@ huggingface-cli login --token $HUGGINGFACE_TOKEN
 
 您还可以直接将令牌传递给 [`login`]，如下所示：`login(token="hf_xxx")`。这将使用您的用户访问令牌登录到 Hugging Face 模型库，而无需您输入任何内容。但是，如果您这样做，请在共享源代码时要小心。最好从安全保管库中加载令牌，而不是在代码库/笔记本中显式保存它
 
-您一次只能登录一个帐户。如果您使用另一个帐户登录您的机器，您将会从之前的帐户注销。请确保使用命令 `huggingface-cli whoami`来检查您当前使用的是哪个帐户。如果您想在同一个脚本中处理多个帐户，您可以在调用每个方法时提供您的令牌。这对于您不想在您的机器上存储任何令牌也很有用
+您一次只能登录一个帐户。如果您使用另一个帐户登录您的机器，您将会从之前的帐户注销。请确保使用命令 `hf auth whoami`来检查您当前使用的是哪个帐户。如果您想在同一个脚本中处理多个帐户，您可以在调用每个方法时提供您的令牌。这对于您不想在您的机器上存储任何令牌也很有用
 
 <Tip warning={true}>
 

docs/source/de/guides/download.md

@@ -136,53 +136,53 @@ Hier ist eine Tabelle, die die verschiedenen Optionen zusammenfasst, um Ihnen zu
 
 ## Herunterladen mit dem CLI
 
-Sie können den `huggingface-cli download`-Befehl im Terminal verwenden, um Dateien direkt aus dem Hub herunterzuladen. Intern verwendet es die gleichen [`hf_hub_download`] und [`snapshot_download`] Helfer, die oben beschrieben wurden, und gibt den zurückgegebenen Pfad im Terminal aus:
+Sie können den `hf download`-Befehl im Terminal verwenden, um Dateien direkt aus dem Hub herunterzuladen. Intern verwendet es die gleichen [`hf_hub_download`] und [`snapshot_download`] Helfer, die oben beschrieben wurden, und gibt den zurückgegebenen Pfad im Terminal aus:
 
 ```bash
->>> huggingface-cli download gpt2 config.json
+>>> hf download gpt2 config.json
 /home/wauplin/.cache/huggingface/hub/models--gpt2/snapshots/11c5a3d5811f50298f278a704980280950aedb10/config.json
 ```
 
-Standardmäßig wird das lokal gespeicherte Token (mit `huggingface-cli login`) verwendet. Wenn Sie sich ausdrücklich authentifizieren möchten, verwenden Sie die `--token` Option:
+Standardmäßig wird das lokal gespeicherte Token (mit `hf auth login`) verwendet. Wenn Sie sich ausdrücklich authentifizieren möchten, verwenden Sie die `--token` Option:
 
 ```bash
->>> huggingface-cli download gpt2 config.json --token=hf_****
+>>> hf download gpt2 config.json --token=hf_****
 /home/wauplin/.cache/huggingface/hub/models--gpt2/snapshots/11c5a3d5811f50298f278a704980280950aedb10/config.json
 ```
 
 Sie können mehrere Dateien gleichzeitig herunterladen, wobei eine Fortschrittsleiste angezeigt wird und der Snapshot-Pfad zurückgegeben wird, in dem sich die Dateien befinden:
 
 ```bash
->>> huggingface-cli download gpt2 config.json model.safetensors
+>>> hf download gpt2 config.json model.safetensors
 Fetching 2 files: 100%|████████████████████████████████████████████| 2/2 [00:00<00:00, 23831.27it/s]
 /home/wauplin/.cache/huggingface/hub/models--gpt2/snapshots/11c5a3d5811f50298f278a704980280950aedb10
 ```
 
 Wenn Sie die Fortschrittsleisten und mögliche Warnungen stummschalten möchten, verwenden Sie die Option `--quiet`. Dies kann nützlich sein, wenn Sie die Ausgabe an einen anderen Befehl in einem Skript weitergeben möchten.
 
 ```bash
->>> huggingface-cli download gpt2 config.json model.safetensors
+>>> hf download gpt2 config.json model.safetensors
 /home/wauplin/.cache/huggingface/hub/models--gpt2/snapshots/11c5a3d5811f50298f278a704980280950aedb10
 ```
 
 Standardmäßig werden Dateien im Cache-Verzeichnis heruntergeladen, das durch die Umgebungsvariable `HF_HOME` definiert ist (oder `~/.cache/huggingface/hub`, wenn nicht angegeben). Sie können dies mit der Option `--cache-dir` überschreiben:
 
 ```bash
->>> huggingface-cli download gpt2 config.json --cache-dir=./cache
+>>> hf download gpt2 config.json --cache-dir=./cache
 ./cache/models--gpt2/snapshots/11c5a3d5811f50298f278a704980280950aedb10/config.json
 ```
 
 Wenn Sie Dateien in einen lokalen Ordner herunterladen möchten, ohne die Cache-Verzeichnisstruktur, können Sie `--local-dir` verwenden. Das Herunterladen in einen lokalen Ordner hat seine Einschränkungen, die in dieser [Tabelle](https://huggingface.co/docs/huggingface_hub/guides/download#download-files-to-local-folder) aufgeführt sind.
 
 ```bash
->>> huggingface-cli download gpt2 config.json --local-dir=./models/gpt2
+>>> hf download gpt2 config.json --local-dir=./models/gpt2
 ./models/gpt2/config.json
 ```
 
 Es gibt weitere Argumente, die Sie angeben können, um aus verschiedenen Repo-Typen oder Revisionen herunterzuladen und Dateien zum Herunterladen mit Glob-Mustern ein- oder auszuschließen:
 
 ```bash
->>> huggingface-cli download bigcode/the-stack --repo-type=dataset --revision=v1.2 --include="data/python/*" --exclu
+>>> hf download bigcode/the-stack --repo-type=dataset --revision=v1.2 --include="data/python/*" --exclu
 de="*.json" --exclude="*.zip"
 Fetching 206 files:   100%|████████████████████████████████████████████| 206/206 [02:31<2:31, ?it/s]
 /home/wauplin/.cache/huggingface/hub/datasets--bigcode--the-stack/snapshots/9ca8fa6acdbc8ce920a0cb58adcdafc495818ae7
@@ -191,5 +191,5 @@ Fetching 206 files:   100%|█████████████████
 Für eine vollständige Liste der Argumente führen Sie bitte den folgenden Befehl aus:
 
 ```bash
-huggingface-cli download --help
+hf download --help
 ```

docs/source/de/guides/manage-cache.md

@@ -238,20 +238,20 @@ Derzeit werden zwischengespeicherte Dateien nie aus Ihrem lokalen Verzeichnis ge
 Wenn Sie eine neue Revision eines Zweiges herunterladen, werden vorherige Dateien aufbewahrt,
 falls Sie sie wieder benötigen. Daher kann es nützlich sein, Ihr Cache-Verzeichnis zu scannen,
 um zu erfahren, welche Repos und Revisionen den meisten Speicherplatz beanspruchen.
-`huggingface_hub` bietet einen Helfer dafür, der über `huggingface-cli` oder in einem Python-Skript verwendet werden kann.
+`huggingface_hub` bietet einen Helfer dafür, der über `hf` oder in einem Python-Skript verwendet werden kann.
 
 ### Cache vom Terminal aus scannen
 
-Die einfachste Möglichkeit, Ihr HF-Cache-System zu scannen, besteht darin, den Befehl `scan-cache`
-aus dem `huggingface-cli`-Tool zu verwenden. Dieser Befehl scannt den Cache und gibt einen Bericht
+Die einfachste Möglichkeit, Ihr HF-Cache-System zu scannen, besteht darin, den Befehl `cache scan`
+aus dem `hf`-Tool zu verwenden. Dieser Befehl scannt den Cache und gibt einen Bericht
 mit Informationen wie Repo-ID, Repo-Typ, Speicherverbrauch, Referenzen und vollständigen lokalen Pfad aus.
 
 Im folgenden Ausschnitt wird ein Scan-Bericht in einem Ordner angezeigt, in dem 4 Modelle und 2 Datensätze
 gecached sind.
 
 
 ```text
-➜ huggingface-cli scan-cache
+➜ hf cache scan
 REPO ID                     REPO TYPE SIZE ON DISK NB FILES LAST_ACCESSED LAST_MODIFIED REFS                LOCAL PATH
 --------------------------- --------- ------------ -------- ------------- ------------- ------------------- -------------------------------------------------------------------------
 glue                        dataset         116.3K       15 4 days ago    4 days ago    2.4.0, main, 1.17.0 /home/wauplin/.cache/huggingface/hub/datasets--glue
@@ -274,7 +274,7 @@ Zum Beispiel hat hier `bert-base-cased` 2 Revisionen von 1,4G und 1,5G,
 aber der gesamte Festplattenspeicher beträgt nur 1,9G.
 
 ```text
-➜ huggingface-cli scan-cache -v
+➜ hf cache scan -v
 REPO ID                     REPO TYPE REVISION                                 SIZE ON DISK NB FILES LAST_MODIFIED REFS        LOCAL PATH
 --------------------------- --------- ---------------------------------------- ------------ -------- ------------- ----------- ----------------------------------------------------------------------------------------------------------------------------
 glue                        dataset   9338f7b671827df886678df2bdd7cc7b4f36dffd        97.7K       14 4 days ago    main, 2.4.0 /home/wauplin/.cache/huggingface/hub/datasets--glue/snapshots/9338f7b671827df886678df2bdd7cc7b4f36dffd
@@ -300,7 +300,7 @@ um die Einträge zu filtern. Hier ein Beispiel, um nur Revisionen vom Modell "t5
 auf einem Unix-basierten Gerät zu filtern.
 
 ```text
-➜ eval "huggingface-cli scan-cache -v" | grep "t5-small"
+➜ eval "hf cache scan -v" | grep "t5-small"
 t5-small                    model     98ffebbb27340ec1b1abd7c45da12c253ee1882a       726.2M        6 1 week ago    refs/pr/1   /home/wauplin/.cache/huggingface/hub/models--t5-small/snapshots/98ffebbb27340ec1b1abd7c45da12c253ee1882a
 t5-small                    model     d0a119eedb3718e34c648e594394474cf95e0617       485.8M        6 4 weeks ago               /home/wauplin/.cache/huggingface/hub/models--t5-small/snapshots/d0a119eedb3718e34c648e594394474cf95e0617
 t5-small                    model     d78aea13fa7ecd06c29e3e46195d6341255065d5       970.7M        9 1 week ago    main        /home/wauplin/.cache/huggingface/hub/models--t5-small/snapshots/d78aea13fa7ecd06c29e3e46195d6341255065d5
@@ -374,7 +374,7 @@ HFCacheInfo(
 
 Das Durchsuchen Ihres Caches ist interessant, aber was Sie normalerweise als Nächstes tun möchten, ist
 einige Teile zu löschen, um etwas Speicherplatz auf Ihrem Laufwerk freizugeben. Dies ist möglich mit dem
-`delete-cache` CLI-Befehl. Man kann auch programmatisch den
+`cache delete` CLI-Befehl. Man kann auch programmatisch den
 [`~HFCacheInfo.delete_revisions`] Helfer vom [`HFCacheInfo`] Objekt verwenden, das beim
 Durchsuchen des Caches zurückgegeben wird.
 
@@ -413,7 +413,7 @@ Fehler ausgelöst. Die Löschung wird für andere Pfade im
 ### Cache vom Terminal aus leeren
 
 Der einfachste Weg, einige Revisionen aus Ihrem HF-Cache-System zu löschen, ist die Verwendung des
-`delete-cache` Befehls vom `huggingface-cli` Tool. Der Befehl hat zwei Modi. Standardmäßig wird dem Benutzer
+`cache delete` Befehls vom `hf` Tool. Der Befehl hat zwei Modi. Standardmäßig wird dem Benutzer
 eine TUI (Terminal User Interface) angezeigt, um auszuwählen, welche Revisionen gelöscht werden sollen. Diese TUI
 befindet sich derzeit in der Beta-Phase, da sie nicht auf allen Plattformen getestet wurde. Wenn die TUI auf Ihrem
 Gerät nicht funktioniert, können Sie sie mit dem Flag `--disable-tui` deaktivieren.
@@ -430,7 +430,7 @@ pip install huggingface_hub["cli"]
 Führen Sie dann den Befehl aus:
 
 ```
-huggingface-cli delete-cache
+hf cache delete
 ```
 
 Sie sollten jetzt eine Liste von Revisionen sehen, die Sie auswählen/abwählen können:
@@ -455,7 +455,7 @@ letzte Bestätigungsnachricht angezeigt. Drücken Sie erneut `<Enter>`, und die
 abbrechen möchten, geben Sie `n` ein.
 
 ```txt
-✗ huggingface-cli delete-cache --dir ~/.cache/huggingface/hub
+✗ hf cache delete --dir ~/.cache/huggingface/hub
 ? Select revisions to delete: 2 revision(s) selected.
 ? 2 revisions selected counting for 3.1G. Confirm deletion ? Yes
 Start deletion.
@@ -480,15 +480,15 @@ wie viel Speicherplatz mit der aktualisierten Revisionsliste freigegeben würde.
 Sie können die Datei weiter bearbeiten oder mit `"y"` bestätigen.
 
 ```sh
-huggingface-cli delete-cache --disable-tui
+hf cache delete --disable-tui
 ```
 
 Beispiel für eine Befehlsdatei:
 
 ```txt
 # INSTRUCTIONS
 # ------------
-# This is a temporary file created by running `huggingface-cli delete-cache` with the
+# This is a temporary file created by running `hf cache delete` with the
 # `--disable-tui` option. It contains a set of revisions that can be deleted from your
 # local cache directory.
 #

docs/source/de/guides/model-cards.md

@@ -188,7 +188,7 @@ print(card)
 
 ## Model Cards teilen
 
-Wenn Sie mit dem Hugging Face Hub authentifiziert sind (entweder durch Verwendung von `huggingface-cli login` oder [`login`]), können Sie Karten zum Hub hinzufügen, indem Sie einfach [`ModelCard.push_to_hub`] aufrufen. Schauen wir uns an, wie das funktioniert...
+Wenn Sie mit dem Hugging Face Hub authentifiziert sind (entweder durch Verwendung von `hf auth login` oder [`login`]), können Sie Karten zum Hub hinzufügen, indem Sie einfach [`ModelCard.push_to_hub`] aufrufen. Schauen wir uns an, wie das funktioniert...
 
 Zuerst erstellen wir ein neues Repo namens 'hf-hub-modelcards-pr-test' im Namensraum des authentifizierten Benutzers:
 

docs/source/de/guides/upload.md

@@ -16,9 +16,9 @@ Wenn Sie Dateien auf den Hub hochladen möchten, müssen Sie sich bei Ihrem Hugg
 - Melden Sie sich bei Ihrem Hugging Face-Konto mit dem folgenden Befehl an:
 
   ```bash
-  huggingface-cli login
+  hf auth login
   # oder mit einer Umgebungsvariable
-  huggingface-cli login --token $HUGGINGFACE_TOKEN
+  hf auth login --token $HUGGINGFACE_TOKEN
   ```
 
 - Alternativ können Sie sich in einem Notebook oder einem Skript programmatisch mit [`login`] anmelden:
@@ -378,7 +378,7 @@ Für weitere Details zu dieser Empfehlung werfen Sie bitte einen Blick auf diese
 Git LFS verarbeitet automatisch Dateien, die größer als 10MB sind. Für sehr große Dateien (>5GB) müssen Sie jedoch einen benutzerdefinierten Transferagenten für Git LFS installieren:
 
 ```bash
-huggingface-cli lfs-enable-largefiles
+hf lfs-enable-largefiles .
 ```
 
 Sie sollten dies für jedes Repository installieren, das eine sehr große Datei enthält. Einmal installiert, können Sie Dateien hochladen, die größer als 5GB sind.

docs/source/de/quick-start.md

@@ -53,9 +53,9 @@ In vielen Fällen müssen Sie mit einem Hugging Face-Konto angemeldet sein, um m
 Sobald Sie Ihr "User Access Token" haben, führen Sie den folgenden Befehl in Ihrem Terminal aus:
 
 ```bash
-huggingface-cli login
+hf auth login
 # or using an environment variable
-huggingface-cli login --token $HUGGINGFACE_TOKEN
+hf auth login --token $HUGGINGFACE_TOKEN
 ```
 
 Alternativ können Sie sich auch programmatisch in einem Notebook oder einem Skript mit [`login`] anmelden:
@@ -67,7 +67,7 @@ Alternativ können Sie sich auch programmatisch in einem Notebook oder einem Skr
 
 Es ist auch möglich, sich programmatisch anzumelden, ohne aufgefordert zu werden, Ihr Token einzugeben, indem Sie das Token direkt an [`login`] weitergeben, wie z.B. `login(token="hf_xxx")`. Seien Sie vorsichtig, wenn Sie Ihren Quellcode teilen. Es ist eine bewährte Methode, das Token aus einem sicheren Tresor/Vault zu laden, anstatt es explizit in Ihrer Codebasis/Notebook zu speichern.
 
-Sie können nur auf 1 Konto gleichzeitig angemeldet sein. Wenn Sie Ihren Computer mit einem neuen Konto anmelden, werden Sie vom vorherigen abgemeldet. Mit dem Befehl `huggingface-cli whoami` stellen Sie sicher, dass Sie immer wissen, welches Konto Sie gerade verwenden. Wenn Sie mehrere Konten im selben Skript verwalten möchten, können Sie Ihr Token bereitstellen, wenn Sie jede Methode aufrufen. Dies ist auch nützlich, wenn Sie kein Token auf Ihrem Computer speichern möchten.
+Sie können nur auf 1 Konto gleichzeitig angemeldet sein. Wenn Sie Ihren Computer mit einem neuen Konto anmelden, werden Sie vom vorherigen abgemeldet. Mit dem Befehl `hf auth whoami` stellen Sie sicher, dass Sie immer wissen, welches Konto Sie gerade verwenden. Wenn Sie mehrere Konten im selben Skript verwalten möchten, können Sie Ihr Token bereitstellen, wenn Sie jede Methode aufrufen. Dies ist auch nützlich, wenn Sie kein Token auf Ihrem Computer speichern möchten.
 
 <Tip warning={true}>