Add telemetry to CLI

src/huggingface_hub/cli/_cli_utils.py

@@ -22,6 +22,7 @@
 
 from huggingface_hub import __version__
 from huggingface_hub.hf_api import HfApi
+from huggingface_hub.utils import send_telemetry
 
 
 class ANSI:
@@ -89,13 +90,42 @@ def list_commands(self, ctx: click.Context) -> list[str]:  # type: ignore[name-d
         return sorted(self.commands.keys())
 
 
+def telemetry_callback(ctx: typer.Context):
+    """Send telemetry for each command executed.
+
+    Only the command is logged, not its arguments or options.
+    Telemetry is anonymous (no user information or token is sent).
+    Telemetry can be disabled by setting the `HF_HUB_DISABLE_TELEMETRY` environment variable.
+    """
+    if not (
+        # Typer groups are called in cascade, so we only want to log once the subcommand is actually a command and
+        # not a group.
+        isinstance(ctx.command, click.core.Group)
+        and isinstance(ctx.command.commands.get(ctx.invoked_subcommand), click.core.Group)  # type: ignore
+    ):
+        # Read full command path in reverse order to build topic
+        topic_parts = []
+        if ctx.invoked_subcommand:
+            topic_parts.append(ctx.invoked_subcommand)
+        while ctx:
+            if ctx.info_name:
+                topic_parts.append(ctx.info_name)
+            ctx = ctx.parent  # type: ignore
+
+        # e.g. "hf auth list" => "hf/auth/list"
+        #      "hf download openai-community/gpt2" => "hf/download"
+        topic = "/".join(reversed(topic_parts))
+        send_telemetry(topic=topic, library_name="hf", library_version=__version__)
+
+
 def typer_factory(help: str) -> typer.Typer:
     return typer.Typer(
         help=help,
         add_completion=True,
         rich_markup_mode=None,
         no_args_is_help=True,
         cls=AlphabeticalMixedGroup,
+        callback=telemetry_callback,
     )
 
 

src/huggingface_hub/cli/hf.py

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
 from huggingface_hub.cli._cli_utils import typer_factory
 from huggingface_hub.cli.auth import auth_cli
 from huggingface_hub.cli.cache import cache_cli