Skip to content

Rename CLI to 'hf' + reorganize syntax #3229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Rename CLI to 'hf' + reorganize syntax #3229

wants to merge 5 commits into from

Conversation

Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Jul 17, 2025

Closes #3224.
Partly inspired by #3225 but I preferred to start from scratch.

Goal is to rename huggingface-cli to hf + harmonize the syntax. We mostly follow a hf <resource> <action> [options] syntax similar to what's done by github CLI https://cli.github.com/manual/gh.

✗ hf --help
usage: hf <command> [<args>]

positional arguments:
  {auth,cache,download,repo,repo-files,upload,upload-large-folder,env,version,lfs-enable-largefiles,lfs-multipart-upload}
                        hf command helpers
    auth                Manage authentication (login, logout, etc.).
    cache               Manage local cache directory.
    download            Download files from the Hub
    repo                Manage repos on the Hub.
    repo-files          Manage files in a repo on the Hub.
    upload              Upload a file or a folder to the Hub. Recommended for single-commit uploads.
    upload-large-folder
                        Upload a large folder to the Hub. Recommended for resumable uploads.
    env                 Print information about the environment.
    version             Print information about the hf version.

options:
  -h, --help            show this help message and exit

Next steps will be to add new commands for a more consistent and feature-complete CLI, but story for another day!

@Wauplin Wauplin changed the title Rename CLI to 'hf' + reorganize them Rename CLI to 'hf' + reorganize syntax Jul 17, 2025
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@huggingface huggingface locked and limited conversation to collaborators Jul 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Smoothly switch CLI to hf
2 participants