Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/python-quality.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ jobs:
- run: .venv/bin/python utils/check_static_imports.py
- run: .venv/bin/python utils/check_all_variable.py
- run: .venv/bin/python utils/generate_async_inference_client.py
- run: .venv/bin/python utils/generate_cli_reference.py --verbose
- run: .venv/bin/python utils/generate_inference_types.py
- run: .venv/bin/python utils/check_task_parameters.py
- run: uvx ty check src
Expand Down
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ quality:
python utils/check_static_imports.py
python utils/check_all_variable.py
python utils/generate_async_inference_client.py
python utils/generate_cli_reference.py

ty check src

Expand All @@ -20,6 +21,7 @@ style:
python utils/check_static_imports.py --update
python utils/check_all_variable.py --update
python utils/generate_async_inference_client.py --update
python utils/generate_cli_reference.py --update

inference_check:
python utils/generate_inference_types.py
Expand Down
2 changes: 2 additions & 0 deletions docs/source/en/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,8 @@
title: Environment variables
- local: package_reference/hf_api
title: Hugging Face Hub API
- local: package_reference/cli
title: CLI
- local: package_reference/file_download
title: Downloading files
- local: package_reference/mixins
Expand Down
4 changes: 4 additions & 0 deletions docs/source/en/guides/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ rendered properly in your Markdown viewer.

The `huggingface_hub` Python package comes with a built-in CLI called `hf`. This tool allows you to interact with the Hugging Face Hub directly from a terminal. For example, you can login to your account, create a repository, upload and download files, etc. It also comes with handy features to configure your machine or manage your cache. In this guide, we will have a look at the main features of the CLI and how to use them.

> [!TIP]
> This guide covers the most important features of the `hf` CLI.
> For a complete reference of all commands and options, see the [CLI reference](../package_reference/cli.md).

## Getting started

First of all, let's install the CLI:
Expand Down
Loading
Loading