Client library to download and publish models, datasets and other repos on the huggingface.co hub
Project description
The official CLI and Python client for the Hugging Face Hub.
About
·
Documentation
·
Install
·
CLI Guide
·
Contributing
English | Deutsch | Français | हिंदी | 한국어 | 中文 (简体) | ಕನ್ನಡ
Quick start
Install the hf CLI with the standalone installer:
# On macOS and Linux.
curl -LsSf https://hf.co/cli/install.sh | bash
# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://hf.co/cli/install.ps1 | iex"
Log in, then start working with the Hub:
# Log in (use --token $HF_TOKEN in non-interactive environments)
hf auth login
# Find models served by Inference Providers
hf models ls --warm
# Download a model
hf download Qwen/Qwen3-0.6B
# Upload files to your own repo
hf upload username/my-cool-model ./model.safetensors
# Sync a local folder to a storage bucket
hf buckets sync ./checkpoints hf://buckets/username/my-bucket
# Run a job on Hugging Face infrastructure
hf jobs run python:3.12 python -c "print('Hello from the cloud!')"
# Discover everything else
hf --help
The Hub uses tokens to authenticate applications (see docs). Check out the CLI guide for a tour of the main features.
What is huggingface_hub?
The huggingface_hub library allows you to interact with the Hugging Face Hub, a platform democratizing open-source Machine Learning for creators and collaborators. Discover pre-trained models and datasets for your projects, play with the thousands of machine learning apps hosted on the Hub, or create and share your own models, datasets and demos with the community. Everything ships in one package with two interfaces: the hf CLI for your terminal and the huggingface_hub library for Python — both designed to work well for humans and AI agents. Use them to:
- Download files from the Hub.
- Upload files to the Hub.
- Manage your repositories.
- Run Inference on deployed models.
- Run Jobs on Hugging Face infrastructure.
- Search for models, datasets and Spaces.
- Share Model Cards to document your models.
- Engage with the community through PRs and comments.
- Do all of the above from the terminal with the
hfCLI.
Built for humans and AI agents
The hf CLI is designed for people and coding agents alike: the same commands adapt their output when run by an agent. If you use Claude Code, Codex, Cursor, or another coding agent, install the hf CLI Skill — a command reference generated from your installed CLI:
# for Codex, Cursor, OpenCode, Pi and other agents that load skills from `.agents/skills`
hf skills add
# includes the above + Claude Code
hf skills add --claude
Learn more in the Hugging Face CLI for AI agents guide and the announcement blog post.
Use the Python library
Install the huggingface_hub package with pip (this also installs the hf CLI):
pip install huggingface_hub
We recommend using uv for a fast and reliable install:
uv pip install huggingface_hub
In order to keep the package minimal by default, huggingface_hub comes with optional dependencies useful for some use cases. For example, if you want to use the MCP module, run:
pip install "huggingface_hub[mcp]"
To learn more about installation and optional dependencies, check out the installation guide.
Download files
Download a single file
from huggingface_hub import hf_hub_download
hf_hub_download(repo_id="zai-org/GLM-5.2", filename="config.json")
Or an entire repository
from huggingface_hub import snapshot_download
snapshot_download("sentence-transformers/all-MiniLM-L6-v2")
Files will be downloaded in a local cache folder. More details in this guide.
Create a repository
from huggingface_hub import create_repo
create_repo(repo_id="super-cool-model")
Upload files
Upload a single file
from huggingface_hub import upload_file
upload_file(
path_or_fileobj="/home/lysandre/dummy-test/README.md",
path_in_repo="README.md",
repo_id="lysandre/test-model",
)
Or an entire folder
from huggingface_hub import upload_folder
upload_folder(
folder_path="/path/to/local/space",
repo_id="username/my-cool-space",
repo_type="space",
)
More details in the upload guide.
Integrating with the Hub.
We're partnering with cool open source ML libraries to provide free model hosting and versioning. You can find the existing integrations here.
The advantages are:
- Free model or dataset hosting for libraries and their users.
- Built-in file versioning, even with very large files, made possible by Xet, the Hub's chunk-deduplicated storage backend.
- In-browser widgets to play with the uploaded models.
- Anyone can upload a new model for your library, they just need to add the corresponding tag for the model to be discoverable.
- Fast downloads! We use Cloudfront (a CDN) to geo-replicate downloads so they're blazing fast from anywhere on the globe.
- Usage stats and more features to come.
If you would like to integrate your library, feel free to open an issue to begin the discussion. We wrote a step-by-step guide with ❤️ showing how to do this integration.
Contributions (feature requests, bugs, etc.) are super welcome 💙💚💛💜🧡❤️
Everyone is welcome to contribute, and we value everybody's contribution. Code is not the only way to help the community. Answering questions, helping others, reaching out and improving the documentations are immensely valuable to the community. We wrote a contribution guide to summarize how to get started to contribute to this repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file huggingface_hub-1.24.0rc3.tar.gz.
File metadata
- Download URL: huggingface_hub-1.24.0rc3.tar.gz
- Upload date:
- Size: 922.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0482c00e0adc9f591dd12d353e05c19be727826b9c2f5a5c412b8503990518b4
|
|
| MD5 |
2fc904ba0b9a9d2be253629132ab7afc
|
|
| BLAKE2b-256 |
623888a79e375801d2c0036b34ba6263313f93054ce17548b47e7031b5395124
|
Provenance
The following attestation bundles were made for huggingface_hub-1.24.0rc3.tar.gz:
Publisher:
release.yml on huggingface/huggingface_hub
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
huggingface_hub-1.24.0rc3.tar.gz -
Subject digest:
0482c00e0adc9f591dd12d353e05c19be727826b9c2f5a5c412b8503990518b4 - Sigstore transparency entry: 2189568901
- Sigstore integration time:
-
Permalink:
huggingface/huggingface_hub@b2ae5b6a898d5303e55c256aa714f9f9a1f4bd70 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/huggingface
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@b2ae5b6a898d5303e55c256aa714f9f9a1f4bd70 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file huggingface_hub-1.24.0rc3-py3-none-any.whl.
File metadata
- Download URL: huggingface_hub-1.24.0rc3-py3-none-any.whl
- Upload date:
- Size: 771.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cba9ed384af5f69a2d39ffe658ce1e9cb1ade8ab823660e3c9c32e92d60b5345
|
|
| MD5 |
a22ed13a636dac51a75e21ea116603a9
|
|
| BLAKE2b-256 |
5b2186931c153e7a8f51577b0b61545ef273cb10eb80fa7f4bdc375066b2891a
|
Provenance
The following attestation bundles were made for huggingface_hub-1.24.0rc3-py3-none-any.whl:
Publisher:
release.yml on huggingface/huggingface_hub
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
huggingface_hub-1.24.0rc3-py3-none-any.whl -
Subject digest:
cba9ed384af5f69a2d39ffe658ce1e9cb1ade8ab823660e3c9c32e92d60b5345 - Sigstore transparency entry: 2189568927
- Sigstore integration time:
-
Permalink:
huggingface/huggingface_hub@b2ae5b6a898d5303e55c256aa714f9f9a1f4bd70 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/huggingface
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@b2ae5b6a898d5303e55c256aa714f9f9a1f4bd70 -
Trigger Event:
workflow_dispatch
-
Statement type: